My name: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
mNo edit summary
imported>StDoodle
mNo edit summary
Line 1: Line 1:
{{FunctionPage |
{{FunctionPage |
page_name=my_name|
page_name=my_name|
function_category=Your Character |
function1_return_type=string|
function1_return_type=string|
function_description=Returns the name of the logged-in character.|
function_description=Returns the name of the logged-in character.|
Line 32: Line 33:
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]]

Revision as of 12:43, 25 February 2010

Function Syntax

Returns the name of the logged-in character.

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 capitalization is not strictly adhered to (much as with the chat command "/whois" in game). The following two examples are functionally equivalent.

if (my_name() == "MyCharacter") {
  //code
}
if (my_name() == "mycharacter") {
  //code
}

Special

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