getExposedTokens: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: ==Function getExposedTokens== {{ProposedChange}} {{TrustedOnlyFunction}} Gets a string list containing the ids of all of the tokens on the current [[...)
 
Line 1: Line 1:
==Function getExposedTokens==
==Function getExposedTokens==
{{ProposedChange}}
{{TrustedOnlyFunction}}
{{TrustedOnlyFunction}}
Gets a [[Macros:string list|string list]] containing the ids 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 ids 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:58, 6 December 2008

Function getExposedTokens

This function can only be called from a trusted macro

Gets a string list containing the ids 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 ids.

Example

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

[h: names = getExposedTokens()]
[r: foreach(id, ids "<br>"): id]