setAllStates: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version, cleaned up formatting.) |
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
||
| Line 1: | Line 1: | ||
{{stub}} | {{stub|Examples using new functionality.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name=setAllSates | |name=setAllSates | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
Sets all of the [[ | Sets all of the [[State|States]] of a [[Token]] to on ({{true}}) or off ({{false}}). | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
setAllStates(value) | setAllStates(value) | ||
</source> | |||
<source lang="mtmacro" line> | |||
setAllStates(value, id) | |||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|value|If all states should be set on or off, {{true}} or {{false}}.}} | |||
{{param|id|The token {{code|id}} of the token that should have its [[State|States]] set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
|examples= | |examples= | ||
Set all [[Token:state|Token States]] on | Set all [[Token:state|Token States]] on | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: setAllStates(1)] | |||
</source> | </source> | ||
Set all [[Token:state|Token States]] off | Set all [[Token:state|Token States]] off | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: setAllStates(0)] | |||
</source> | </source> | ||
|also= | |||
[[State]], | |||
[[getState|getState()]], | |||
[[setState|setState()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:State Function]] | [[Category:State Function]] | ||
Revision as of 01:27, 31 March 2009
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
Usage
setAllStates(value)setAllStates(value, id)Parameter
value- If all states should be set on or off,true(1) orfalse(0).id- The tokenidof the token that should have its States set, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
Examples
See Also
Version Changes
- 1.3b51 - Added
idparameter option.