selectTokens

Contents 1 selectTokens() Function 1.1 Usage 1.2 Example 1.3 See Also 1.4 Version Changes

selectTokens() Function

Selects one or more visible tokens on the map.

Usage

Parameter

• id - the id string or token name of a specific token to select (the examples below use token names, but IDs are also permitted); if left blank all visible tokens are selected.
• add - if the value of add is true(1), the selections will be added to the current set of selected tokens; if the value is false(0) currently selected tokens will be deselected before new tokens are selected. Defaults to false.
• tokens - a String List of tokens to select.
• delim - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for list may be a JSON Array instead. Note: if using a JSON Array or String List, both add and delim must be specified.

Example

To select a single token with the name "Adventurer":

To select a list of Tokens using a String List, replacing the current selection

To select a list of Tokens using a JSON Array, adding the specified tokens to the current set of selected Tokens:

See Also

deselectTokens(), getSelected(), getSelectedNames()

Version Changes

• 1.3b68 - Function added.

Token: A visual marker representing a character, monster, or NPCString List: A string containing a list of items in the format "item1, item2, item3,..."Map: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.