setState: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
Verisimilar (talk | contribs) mNo edit summary |
||
| Line 16: | Line 16: | ||
{{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 token {{code|id}} of the token which has its [[State]] set, defaults to the [[Current Token]].}} | {{param|id|The token {{code|id}} of the token which has its [[State]] set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
|examples= | |examples= | ||
Revision as of 01:28, 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.Note: This parameter can only be used in a Trusted Macro.
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.