getOwned: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
|||
| Line 1: | Line 1: | ||
= | {{MacroFunction | ||
{{ | |name=getOwned | ||
|trusted=true | |||
|description=Returns a list containing the ids of the [[token|token]]s on the current [[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 [[String List|string list]] is returned with the default value of {{code|","}} is used. | |||
* If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned. | |||
* Otherwise a [[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)] | ||
[h: tokenIds = getOwned(player, delim)] | [h: tokenIds = getOwned(player, delim)] | ||
</source> | </source> | ||
delim is the delimiter used to separate the values in the [[ | {{code|delim}} is the delimiter used to separate the values in the [[String List|string list]] which defaults to {{code|","}} if not specified. | ||
|example= | |||
To display the ids of all of the [[Token|token]]s on the current [[Map|map]] by the [[Player]] use. | |||
To display the ids of all of the [[Token | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: ids = getOwned(getPlayerName())] | [h: ids = getOwned(getPlayerName())] | ||
[foreach(id, ids, "<br>"): id] | [foreach(id, ids, "<br>"): id] | ||
</source> | </source> | ||
|changes= | |||
* '''1.3b49''' - Added {{code|json}} delimiter option. | |||
|also= | |||
[[foreach|foreach()]] | |||
}} | |||
[[Category:Token Function]] | |||
Revision as of 02:50, 8 March 2009
getOwned() Function
Note: This function can only be used in 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
jsonthen a json array is returned. - 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.
Example
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]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.