getOwned

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 json then 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

foreach()

Version Changes

• 1.3b49 - Added json delimiter option.