getOwnedNames: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
Verisimilar (talk | contribs) m (Macros:Functions:getOwnedNames moved to getOwnedNames) |
(No difference)
|
Revision as of 02:56, 8 March 2009
getOwnedNames() Function
Note: This function can only be used in a Trusted Macro
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
json
then a json array is returned. - Otherwise a string list is returned with the delimiter passed in.
Usage
[h: names = getOwnedNames(player)]
[h: names = 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
json
delimiter option.