getTokenStates

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

<source lang="mtmacro" line> getTokenStates() getTokenStates(delim) getTokenStates(delim, groupName) getTokenStates(delim, groupName, id) getTokenStates(delim, groupName, id, mapname) </syntaxhighlight> 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.

   Note: This parameter can only be used in a Trusted Macro. 

• 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.

<source lang="mtmacro" line> [h: states = getTokenStates()] </syntaxhighlight>

To get a JSON Array of the valid Token States in the campaign. <source lang="mtmacro" line> [h: states = getTokenStates("json")] </syntaxhighlight>

To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later. <source lang="mtmacro" line> [h: states = getTokenStates("json", "Damage")] </syntaxhighlight>

To get a JSON Array of the Token States set to true(1) for the "Dragon" token: <source lang="mtmacro" line> [h: states = getTokenStates("json", "*", "Dragon")]

</syntaxhighlight>

Version Changes

• 1.3b55 - Added the groupName parameter.
• 1.5.7 - Added id and mapname parameter options.