setState: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version, cleaned up formatting.)
No edit summary
Line 26: Line 26:
}}
}}
[[Category:State Function]]
[[Category:State Function]]
[[Category:Token Function]]

Revision as of 06:12, 16 March 2009

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

setState() Function

Introduced in version 1.3b40
Sets the value of the Token State on the Current Token. If The value is 0 then the Token State is unset if it is non zero then it is set.

Usage

setState(state, value)

Parameters

  • state - The name of the state to set on the current token.
  • value - The value of the state to set, true(1) or false(0).

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)]