selectTokens: Difference between revisions

Revision as of 23:31, 22 May 2024

• Introduced in version 1.3b68

Selects one or more visible tokens on the map.

selectTokens()

selectTokens(tokenRef, add)

selectTokens(tokens, add, delim)

Parameter

tokenRef - Either the token id or Token Name of the 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 tokens may be a JSON Array instead. Note: if using a JSON Array or String List, both add and 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.

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

[h:selectTokens("Adventurer")]

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

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

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

[h:selectTokens("['Adventurer', 'Orc 2', 'Goblin 1']", 1, "json")]

@@ Line 10: / Line 10: @@
 </syntaxhighlight>
 <syntaxhighlight lang="mtmacro" line>
-selectTokens(id, add)
+selectTokens(tokenRef, add)
 </syntaxhighlight>
 <syntaxhighlight lang="mtmacro" line>
@@ Line 17: / Line 17: @@
 '''Parameter'''
-* {{code|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.
+* {{code|tokenRef}} - Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to select (the examples below use token ''names'', but IDs are also permitted); if left blank ''all'' visible tokens are selected.
 * {{code|add}} - if the value of add is {{code|true(1)}}, the selections will be added to the current set of selected tokens; if the value is {{code|false(0)}} currently selected tokens will be deselected before new tokens are selected. Defaults to false.
 * {{code|tokens}} - a [[String List]] of tokens to select.
 * {{code|delim}} - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for {{code|tokens}} may be a [[JSON Array]] instead. '''Note: if using a JSON Array or String List, both {{code|add}} and {{code|delim}} must be specified.'''
+{{Note|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=