setAllStates

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples using new functionality.

setAllStates() Function

• Introduced in version 1.3b40

Sets all of the States of a Token to on (true(1)) or off (false(0)).

Usage

setAllStates(value)
setAllStates(value, tokenRef)
setAllStates(value, tokenRef, mapRef)

Parameter

• value - If all states should be set on or off, true(1) or false(0).
• tokenRef - Either the token id or Token Name of the token that should have its States set. Defaults to the Current Token.

   Note: This parameter can only be used in a Trusted Macro. 

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Examples

Set all Token States on

[h: setAllStates(1)]

Set all Token States off

[h: setAllStates(0)]

See Also

State, getState(), setState()

Version Changes

• 1.3b51 - Added id parameter option.
• 1.5.4 - Added mapname parameter option.