deselectTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: {{MacroFunction |name=deselectTokens |version=1.3b68 |description= Deselects one or more visible tokens on the map. |usage= <source lang="mtmacro"> deselectTokens() </source> <source lan...)
 
No edit summary
Line 32: Line 32:
</source>
</source>


|also=
[[selectTokens|selectTokens()]],
[[getSelected|getSelected()]],
[[getSelectedNames|getSelectedNames()]]


|changes=
|changes=

Revision as of 17:20, 2 June 2010

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 of a specific token to deselect; 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.

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.