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.

setAllSates() 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, id)
setAllStates(value, id, mapname)

Parameter

• value - If all states should be set on or off, true(1) or false(0).
• id - The id 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. 

• mapname - The name of the map to find the token. Defaults to the current map.

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.