getTokenNames: Difference between revisions

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


Gets a [[Macros:string list|string list]] containing the names of all the [[Token:token|token]]s on the current [[Map:map|map]].
Gets a [[Macros:string list|string list]] containing the names of all the [[Token:token|token]]s on the current [[Map:map|map]].

Revision as of 15:09, 6 December 2008

Function getTokenNames

This function can only be called from a trusted macro


Gets a string list containing the names of all the tokens on the current map.

Usage

[h: player = getTokenNames()]
[h: player = getTokenNames(delim)]

If delim is specified then it is used to separate the values in the list, if it is not specified then it defaults to ','.

Examples

You can use the following code to print out the names of all of the tokens on the current map.

[h: names = getTokenNames()]
[foreach(name, names, "<br>"): name]