getTokenStates

Contents 1 getTokenStates() Function 1.1 Usage 1.2 Example 1.3 Version Changes

getTokenStates() Function

Returns the valid states in the campaign settings in either a String List or JSON Array.

Usage

Parameter

• delim - Specifies the delimiter used in the string list that is returned, defaultis ",". 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. Note that if you wish to use the groupname parameter, you MUST set a delimiter.

Example

To get a String List of the valid Token States in the campaign.

To get a JSON Array of the valid Token States in the campaign.

To get a JSON Array of the valid Token States in the Damage group in the campaign in 1.3b55 or later.

Version Changes

• 1.3b55 - Added the groupName parameter.

Token: A visual marker representing a character, monster, or NPCString List: A string containing a list of items in the format "item1, item2, item3,..."Campaign: A zipped XML file with the '''.cmpgn''' file extension containing tokens, maps, token macros, campaign macros, and token propertiesMap: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.State: A binary (i.e., it has two possible values, 1 or 0) variable that is set for a given token, frequently used for conditions or statuses that affect a particular character in a game.