setState: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 31: Line 31:
|also=
|also=
[[State]],
[[State]],
[[getState|getState()]]
[[getState|getState()]],
[[setAllStates|setAllStates()]]


|changes=
|changes=

Revision as of 01:29, 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) or false(0).
  • id - The token id of 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 id parameter option.