setState

 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

State,

getState(),

setAllStates()

Version Changes

• 1.3b51 - Added id parameter option.
• 1.5.4 - Added mapname parameter option.