deselectTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "<source" to "<syntaxhighlight")
No edit summary
 
Line 10: Line 10:
</syntaxhighlight>
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
deselectTokens(id)
deselectTokens(tokenRef)
</syntaxhighlight>
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Line 17: Line 17:


'''Parameter'''
'''Parameter'''
* {{code|id}} - the id string or name of a specific 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.
* {{code|tokenRef}} - Either the token [[getSelected|{{code|id}}]] or [[getTokenName|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.
* {{code|tokens}} - a [[String List]] of tokens to deselect.
* {{code|tokens}} - a [[String List]] of tokens to deselect.
* {{code|delim}} - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for {{code|list}} may be a [[JSON Array]] instead. '''Note: if using a JSON Array or String List, {{code|delim}} must be specified.'''
* {{code|delim}} - Specifies the delimiter used in the string list that is supplied. If the delimiter is "json", then the value for {{code|list}} may be a [[JSON Array]] instead. '''Note: if using a JSON Array or String List, {{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=
|example=

Latest revision as of 00:01, 13 May 2024

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

Version Changes

  • 1.3b68 - Function added.