setState: Difference between revisions
Jump to navigation
Jump to search
Dranfaelarun (talk | contribs) No edit summary |
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
||
| Line 1: | Line 1: | ||
{{stub}} | {{stub|Examples using new functionality.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name=setState | |name=setState | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
Sets the value of the [[ | Sets the value of the [[State]] on [[Token]]. If The value is {{false}} then the [[State]] is unset if it is non-zero({{true}}) then it is set. | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
setState(state, value) | setState(state, value) | ||
</source> | |||
<source lang="mtmacro" line> | |||
setState(state, value, id) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|state|The name of the state to set on the token.}} | |||
{{param|value|The value of the state to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}} | |||
{{param|id|The token {{code|id}} of the token which has its [[State]] set, defaults to the [[Current Token]].}} | |||
|examples= | |examples= | ||
| Line 24: | Line 28: | ||
[h: setState("Dead", 0)] | [h: setState("Dead", 0)] | ||
</source> | </source> | ||
|also= | |||
[[State]], | |||
[[getState|getState()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:State Function]] | [[Category:State Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 01:22, 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.
setState() Function
• Introduced in version 1.3b40
Sets the value of the State on Token. If The value is
false(0) then the State is unset if it is non-zero(true(1)) then it is set.Usage
setState(state, value)setState(state, value, id)Parameters
state- The name of the state to set on the token.value- The value of the state to set,true(1) orfalse(0).id- The tokenidof the token which has its State set, defaults to the Current Token.
Examples
To set the "Dead" Token State on the Current Token
[h: setState("Dead", 1)]To reset the "Dead" Token State on the Current Token
[h: setState("Dead", 0)]See Also
Version Changes
- 1.3b51 - Added
idparameter option.