Difference between revisions of "My name"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>Bale
m
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{#vardefine:name|my_name}}
+
{{
{{#vardefine:return_type|string}}
+
#vardefine:name|my_name}}{{
 +
#vardefine:return_type|string}}{{
  
{{FunctionPage|
+
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Your Character|
 
 
function1={{Function|
 
function1={{Function|
 
name={{#var:name}}|
 
name={{#var:name}}|
Line 10: Line 10:
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
 
return_also={{#var:return_also}}}}|
 
return_also={{#var:return_also}}}}|
function_description=Returns the name of the logged-in character, all in lowercase.|
+
function_description=Returns the name of the logged-in character (in all-lowercase).|
 
code1={{CodeSample|
 
code1={{CodeSample|
 
title=Code Samples|
 
title=Code Samples|
Line 22: Line 22:
 
   import <MultiBreakfast.ash>;
 
   import <MultiBreakfast.ash>;
 
}
 
}
</syntaxhighlight>}}|
+
</syntaxhighlight>}}
code2={{CodeSample|
+
{{CodeSample|
description=Note that capitalization is not strictly adhered to (much as with the chat command "/whois" in game). The following two examples are functionally equivalent.|
+
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") {
   //code
+
   //some_code_here
 
}
 
}
</syntaxhighlight>}}|
+
</syntaxhighlight>}}
code3={{CodeSample|
+
{{CodeSample|
 
code=
 
code=
 
<syntaxhighlight>
 
<syntaxhighlight>
 
if (my_name() == "mycharacter") {
 
if (my_name() == "mycharacter") {
   //code
+
   //some_code_here
 
}
 
}
 
</syntaxhighlight>}}|
 
</syntaxhighlight>}}|
Line 41: 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

my_id()

Special

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