My name: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle mNo edit summary |
imported>Bale mNo edit summary |
||
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{FunctionPage| | {{ | ||
#vardefine:name|my_name}}{{ | |||
#vardefine:return_type|string}}{{ | |||
function_description=Returns the name of the logged-in character | FunctionPage| | ||
name={{#var:name}}| | |||
function1={{Function| | |||
name={{#var:name}}| | |||
aggregate={{#var:aggregate}}| | |||
return_type={{#var:return_type}}| | |||
return_also={{#var:return_also}}}}| | |||
function_description=Returns the name of the logged-in character (in all-lowercase).| | |||
code1={{CodeSample| | code1={{CodeSample| | ||
title=Code Samples| | title=Code Samples| | ||
description=This example imports different breakfast scripts depending on which character is running the script.| | description=This example imports different breakfast scripts depending on which character is running the script.| | ||
code= | code= | ||
<syntaxhighlight | <syntaxhighlight> | ||
if (my_name() == "MyMain") { | if (my_name() == "MyMain") { | ||
import <MainBreakfast.ash>; | import <MainBreakfast.ash>; | ||
| Line 15: | Line 22: | ||
import <MultiBreakfast.ash>; | import <MultiBreakfast.ash>; | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
{{CodeSample| | |||
description=Note that | description=Note that case doesn't matter for string comparisons, so the following two examples are functionally equivalent.| | ||
code= | code= | ||
<syntaxhighlight | <syntaxhighlight> | ||
if (my_name() == "MyCharacter") { | if (my_name() == "MyCharacter") { | ||
// | //some_code_here | ||
} | } | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
{{CodeSample| | |||
code= | code= | ||
<syntaxhighlight | <syntaxhighlight> | ||
if (my_name() == "mycharacter") { | if (my_name() == "mycharacter") { | ||
// | //some_code_here | ||
} | } | ||
</syntaxhighlight>}}| | </syntaxhighlight>}}| | ||
| Line 34: | Line 41: | ||
special=When not logged in, this function returns an empty string. | special=When not logged in, this function returns an empty string. | ||
}} | }} | ||
[[Category:Your Character]] | |||
Latest revision as of 21:31, 21 May 2010
Function Syntax
string my_name()
Returns the name of the logged-in character (in all-lowercase).
Code Samples
This example imports different breakfast scripts depending on which character is running the script.
if (my_name() == "MyMain") {
import <MainBreakfast.ash>;
}
else if (my_name() == "MyMulti") {
import <MultiBreakfast.ash>;
}Note that case doesn't matter for string comparisons, so the following two examples are functionally equivalent.
if (my_name() == "MyCharacter") {
//some_code_here
}
if (my_name() == "mycharacter") {
//some_code_here
}See Also
Special
When not logged in, this function returns an empty string.