getOwnedNames: Difference between revisions
Jump to navigation
Jump to search
(Fixed broken link) |
mNo edit summary |
||
| Line 7: | Line 7: | ||
* If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned. | * If the delimiter {{code|json}} then a [[JSON Array|json array]] is returned. | ||
* Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | * Otherwise a [[Macros:string list|string list]] is returned with the delimiter passed in. | ||
| |||
|usage= | |usage= | ||
Revision as of 23:26, 2 March 2019
getOwnedNames() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Returns a list containing the names 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
getOwnedNames(player)
getOwnedNames(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: names = getOwnedNames(getPlayerName())]
[foreach(name, names, "<br>"): name]See Also
Version Changes
- 1.3b49 - Added
jsondelimiter option.