setState: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setState(state, value) | setState(state, value) | ||
setState(state, value, id) | setState(state, value, id) | ||
</ | setState(state, value, id, mapname) | ||
</soursyntaxhighlightce> | |||
'''Parameters''' | '''Parameters''' | ||
{{param|state|The name of the state to set on the token.}} | {{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|value|The value of the state to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}} | ||
{{param|id|The | {{param|id|The {{code|id}} of the token to have the [[State]] set. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|examples= | |examples= | ||
To set the "Dead" [[Token:state|Token State]] on the [[Current Token]] | To set the "Dead" [[Token:state|Token State]] on the [[Current Token]] | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setState("Dead", 1)] | [h: setState("Dead", 1)] | ||
</ | </syntaxhighlight> | ||
To reset the "Dead" [[Token:state|Token State]] on the [[Current Token]] | To reset the "Dead" [[Token:state|Token State]] on the [[Current Token]] | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setState("Dead", 0)] | [h: setState("Dead", 0)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
| Line 36: | Line 36: | ||
|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:34, 14 March 2023
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)
</soursyntaxhighlightce>
'''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 {{code|id}} of the token to have the [[State]] set. Defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token. Defaults to the current map.}}
|examples=
To set the "Dead" [[Token:state|Token State]] on the [[Current Token]]
<syntaxhighlight lang="mtmacro" line>
[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.