getOwned

From RPTools Wiki
Revision as of 23:01, 1 December 2008 by Craig (talk | contribs) (New page: ==Function getOwned== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a Macros:string list containing the ids of the Token:tokens on the current Map:map that are owned b...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function getOwned

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

This function can only be called from a trusted macro

Returns a string list containing the ids of the tokens on the current map that are owned by the specified player.

[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(ids, ids, "<br>"): ids]