getOwnedNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getOwnedNames== {{ProposedChange}} {{TrustedOnlyFunction}} Returns a Macros:string list containing the names of the Token:tokens on the current Map:map that are ...)
 
Line 1: Line 1:
==Function getOwnedNames==
==Function getOwnedNames==
{{ProposedChange}}
{{TrustedOnlyFunction}}
{{TrustedOnlyFunction}}


Returns a [[Macros:string list|string list]] containing the names of the [[Token:token|token]]s on the current [[Map:map|map]] that are owned by the specified player.  
Returns a [[Macros:string list|string list]] containing the names of the [[Token:token|token]]s on the current [[Map:map|map]] that are owned by the specified player.  

Revision as of 15:06, 6 December 2008

Function getOwnedNames

This function can only be called from a trusted macro


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

[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]