deselectTokens: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
deselectTokens() | deselectTokens() | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
deselectTokens(id) | deselectTokens(id) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
deselectTokens(tokens, delim) | deselectTokens(tokens, delim) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
* {{code|id}} - the id string of a specific token to deselect; if left blank all currently selected tokens are deselected. | * {{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|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.''' | ||
| Line 23: | Line 23: | ||
|example= | |example= | ||
To deselect a single token with the name "Adventurer": | To deselect a single token with the name "Adventurer": | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:deselectTokens("Adventurer")] | [h:deselectTokens("Adventurer")] | ||
</ | </syntaxhighlight> | ||
To deselect a list of [[Token]]s using a [[String List]]: | To deselect a list of [[Token]]s using a [[String List]]: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h:deselectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")] | [h:deselectTokens("Adventurer, Orc 2, Goblin 1", 0, ",")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 18:53, 14 March 2023
deselectTokens() Function
• Introduced in version 1.3b68
Deselects one or more visible tokens on the map.
Usage
deselectTokens()deselectTokens(id)deselectTokens(tokens, delim)Parameter
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.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 forlistmay be a JSON Array instead. Note: if using a JSON Array or String List,delimmust be specified.
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.