getOwned: Difference between revisions
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
Returns a | Returns a list containing the ids of the [[Token:token|token]]s on the current [[Map:map|map]] that are owned by the specified player. The type of the value returned depends on the delimiter parameter. | ||
* If the delimiter is not specified then a [[Macros:string list|string list]] is returned with the default value of ',' is used. | |||
* If the delimiter ''"json"'' then a [[Macros:json array|json array]] is returned. '''(as of MapTool 1.3b49)''' | |||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | |||
===Usage=== | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: tokenIds = getOwned(player)] | [h: tokenIds = getOwned(player)] | ||
Revision as of 14:32, 24 December 2008
Function getOwned
This function can only be called from a trusted macro
Returns a list containing the ids of the tokens on the current map that are owned by the specified player. The type of the value returned depends on the delimiter parameter.
- If the delimiter is not specified then a string list is returned with the default value of ',' is used.
- If the delimiter "json" then a json array is returned. (as of MapTool 1.3b49)
- Otherwise a string list is returned with the delimiter passed in.
Usage
[h: tokenIds = getOwned(player)]
[h: tokenIds = getOwned(player, delim)]delim is the delimiter used to separate the values in the string list which defaults to ',' if not specified.
Examples
To display the ids of all of the tokens on the current map by the player use.
[h: ids = getOwned(getPlayerName())]
[foreach(id, ids, "<br>"): id]