setState: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) mNo edit summary |
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
||
| Line 19: | Line 19: | ||
|examples= | |examples= | ||
To set the "Dead" [[Token:state|Token State]] on the [[ | To set the "Dead" [[Token:state|Token State]] on the [[Current Token]] | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: setState("Dead", 1)] | [h: setState("Dead", 1)] | ||
</source> | </source> | ||
To reset the "Dead" [[Token:state|Token State]] on the [[ | To reset the "Dead" [[Token:state|Token State]] on the [[Current Token]] | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
[h: setState("Dead", 0)] | [h: setState("Dead", 0)] | ||
Revision as of 21:36, 4 April 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.