deselectTokens

deselectTokens() Function

• Introduced in version 1.3b68

Deselects one or more visible tokens on the map.

Usage

deselectTokens()

deselectTokens(tokenRef)

deselectTokens(tokens, delim)

Parameter

• tokenRef - Either the token id or Token Name of the token to deselect (the examples below use the token name, but token IDs are also valid); if left blank all currently selected tokens are deselected.
• tokens - a String List of tokens to deselect.
• 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, delim must be specified.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Example

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

[h:deselectTokens("Adventurer")]

To deselect a list of Tokens using a String List:

[h:deselectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")]

See Also

selectTokens(),

getSelected(),

getSelectedNames()

Version Changes

• 1.3b68 - Function added.