getExposedTokenNames: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getExposedTokenNames== {{ProposedChange}} {{TrustedOnlyFunction}} Gets a Macros:string list containing the names of all of the Token:tokens on the current Map:map...)
 
No edit summary
Line 15: Line 15:
The following example will print out the names of all the [[Token:token|token]]s on the current [[Map:map|map]] not covered by [[Map:fog of war|fog of war]].
The following example will print out the names of all the [[Token:token|token]]s on the current [[Map:map|map]] not covered by [[Map:fog of war|fog of war]].
<source lang="mtmacro" line>
<source lang="mtmacro" line>
 
[h: names = getExposedTokenNames()] [foreach(name, names, "<br"): name]
</source>
</source>

Revision as of 20:23, 1 December 2008

Function getExposedTokenNames

 Note: This refers to a proposed change that has not been implemented in the main code base yet.

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()] [foreach(name, names, "<br"): name]