getTokenStates: Difference between revisions
Jump to navigation
Jump to search
(Updated for new features in b55 and added more information.) |
No edit summary |
||
| Line 17: | Line 17: | ||
'''Parameter''' | '''Parameter''' | ||
* {{code|delim}} - Specifies the delimiter used in the string list that is returned, defaultis {{code|","}}. If the value is set to {{code|json}}, the function returns a JSON array instead. | * {{code|delim}} - Specifies the delimiter used in the string list that is returned, defaultis {{code|","}}. If the value is set to {{code|json}}, the function returns a JSON array instead. | ||
* {{code|groupName}} - Specifies the name of the group to get the states for. | * {{code|groupName}} - Specifies the name of the group to get the states for. '''Note that if you wish to use the {{code|groupname}} parameter, you MUST set a delimiter. | ||
|example= | |example= | ||
Revision as of 22:42, 26 April 2009
getTokenStates() Function
• Introduced in version 1.3b51
Returns the valid states in the campaign settings in either a String List or JSON Array.
Usage
getTokenStates()getTokenStates(delim)getTokenStates(delim, groupName)Parameter
delim- Specifies the delimiter used in the string list that is returned, defaultis",". If the value is set tojson, the function returns a JSON array instead.groupName- Specifies the name of the group to get the states for. Note that if you wish to use thegroupnameparameter, you MUST set a delimiter.
Example
To get a String List of the valid Token States in the campaign.
[h: states = getTokenStates()]To get a JSON Array of the valid Token States in the campaign.
[h: states = getTokenStates("json")]To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.
[h: states = getTokenStates("json", "Damage")]
Version Changes
- 1.3b55 - Added the
groupNameparameter.