getExposedTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
==Function getExposedTokenNames==
==Function getExposedTokenNames==
{{ProposedChange}}
{{TrustedOnlyFunction}}
{{TrustedOnlyFunction}}
Gets a [[Macros:string list|string list]] containing the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[Map:fog of war|fog of war]]).  
Gets a [[Macros:string list|string list]] containing the names of all of the [[Token:token|token]]s on the current [[Map:map|map]] that have been exposed, (i.e. not covered by [[Map:fog of war|fog of war]]).  



Revision as of 14:57, 6 December 2008

Function getExposedTokenNames

This function can only be called from a trusted macro

Gets a string list containing the names of all of the tokens on the current map that have been exposed, (i.e. not covered by fog of war).

Usage

[h: list = getExposedTokenNames()]
[h: list = getExposedTokenNames(delim)]

If delim is specified then it is used as the delimiter that separates the token names.

Example

The following example will print out the names of all the tokens on the current map not covered by fog of war.

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