getTokenStates: Difference between revisions

Revision as of 11:27, 18 October 2019

getTokenStates() Function

• Introduced in version 1.3b51

Returns the valid states in the campaign settings in either a String List or JSON Array. Alternatively, if a token id is specified, instead returns the list of the states that are set to true(1) for the token.

Usage

getTokenStates()
getTokenStates(delim)
getTokenStates(delim, groupName)
getTokenStates(delim, groupName, id)
getTokenStates(delim, groupName, id, mapname)

Parameter

delim - Specifies the delimiter used in the string list that is returned, default is ",". If the value is set to json, the function returns a JSON array instead.
groupName - Specifies the name of the group to get the states for. If set to "*", get all states.
id - The id of the token to get the states set to true(1). If the parameter is not used, instead returns all valid states in the campaign settings.
mapname - The name of the map where the token is. Set to the current map by default.

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 groupName parameter.
1.5.7 - Added id and mapname parameter options.

@@ Line 3: / Line 3: @@
 |version=1.3b51
 |description=
-Returns the valid states in the campaign settings in either a [[String List]] or [[JSON Array]].
+Returns the valid states in the campaign settings in either a [[String List]] or [[JSON Array]]. Alternatively, if a token id is specified, instead returns the list of the states that are set to {{true}} for the token.
 |usage=
 <source lang="mtmacro" line>
 getTokenStates()
-</source>
-<source lang="mtmacro" line>
 getTokenStates(delim)
-</source>
-<source lang="mtmacro" line>
 getTokenStates(delim, groupName)
+getTokenStates(delim, groupName, id)
+getTokenStates(delim, groupName, id, mapname)
 </source>
 '''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.
+{{param|delim|Specifies the delimiter used in the string list that is returned, default is {{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. '''Note that if you wish to use the {{code|groupname}} parameter, you MUST set a delimiter.
+{{param|groupName|Specifies the name of the group to get the states for. If set to "*", get all states.}}
+{{param|id|The id of the token to get the states set to {{true}}. If the parameter is not used, instead returns all valid states in the campaign settings.}}
+{{param|mapname|The name of the map where the token is. Set to the current map by default.}}
 |example=
@@ Line 38: / Line 38: @@
 |changes=
-* '''1.3b55''' - Added the {{code|groupName}} parameter.
+{{change|1.3b55|Added the {{code|groupName}} parameter.}}
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}}
 }}
 [[Category:State Function]]