setAllStates: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version, cleaned up formatting.)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=setAllSates
|name=setAllSates
|version=1.3b40
|description=
|description=
Sets all of the [[Token:state|Token States]] of the [[Token:Current Token|Current Token]] to on (non zero)  or off (0).
Sets all of the [[Token:state|Token States]] of the [[Token:Current Token|Current Token]] to on (non zero)  or off (0).
Line 6: Line 8:
|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: setAllStates(val)]
setAllStates(value)
</source>
</source>
'''Parameter'''
* {{code|value}} - If all states should be set on or off, {{true}} or {{false}}.


|examples=
|examples=
Line 18: Line 22:
     [h: setAllStates(0)]
     [h: setAllStates(0)]
</source>
</source>
}}
}}
[[Category:State Function]]
[[Category:State Function]]

Revision as of 09:57, 10 March 2009

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

setAllSates() Function

Introduced in version 1.3b40
Sets all of the Token States of the Current Token to on (non zero) or off (0).

Usage

setAllStates(value)

Parameter

  • value - If all states should be set on or off, true(1) or false(0).

Examples

Set all Token States on
    [h: setAllStates(1)]

Set all Token States off

    [h: setAllStates(0)]