My name: Difference between revisions

Latest revision as of 21:31, 21 May 2010

string my_name()

Returns the name of the logged-in character (in all-lowercase).

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
}

When not logged in, this function returns an empty string.

@@ Line 1: / Line 1: @@
-[[string]] [[my_name()]]
+{{
+#vardefine:name|my_name}}{{
+#vardefine:return_type|string}}{{
-This function returns the logged-in character's name as a [[string]].
+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|
+title=Code Samples|
+description=This example imports different breakfast scripts depending on which character is running the script.|
+code=
+<syntaxhighlight>
+if (my_name() == "MyMain") {
+  import <MainBreakfast.ash>;
+}
+else if (my_name() == "MyMulti") {
+  import <MultiBreakfast.ash>;
+}
+</syntaxhighlight>}}
+{{CodeSample|
+description=Note that case doesn't matter for string comparisons, so the following two examples are functionally equivalent.|
+code=
+<syntaxhighlight>
+if (my_name() == "MyCharacter") {
+  //some_code_here
+}
+</syntaxhighlight>}}
+{{CodeSample|
+code=
+<syntaxhighlight>
+if (my_name() == "mycharacter") {
+  //some_code_here
+}
+</syntaxhighlight>}}|
+see_also={{SeeAlso|my_id}}|
+special=When not logged in, this function returns an empty string.
+}}
+[[Category:Your Character]]