setState: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
(Added mapname parameter information) |
||
| Line 12: | Line 12: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
setState(state, value, id) | setState(state, value, id) | ||
</source> | |||
<source lang="mtmacro" line> | |||
setState(state, value, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 17: | Line 20: | ||
{{param|value|The value of the state to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}} | {{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]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its [[State]] set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map where the token is, defaults to the current map.}} | |||
|examples= | |examples= | ||
| Line 36: | Line 40: | ||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:State Function]] | [[Category:State Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 20:16, 14 August 2019
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)setState(state, value, id, mapname)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.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map where the token is, defaults to the current map.
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. - 1.5.4 - Added
mapnameparameter option.