getState: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Updated with recent version changes.)
mNo edit summary
Line 15: Line 15:
'''Parameters'''
'''Parameters'''
{{param|state|The name of the state to check for.}}
{{param|state|The name of the state to check for.}}
{{param|id|The token {{code|id}} of the token to check for the state, defaults to the [[Current Token]].}}
{{param|id|The token {{code|id}} of the token to check for the state, defaults to the [[Current Token]]. {{TrustedParameter}} }}


|example=
|example=
Line 24: Line 24:
|also=
|also=
[[State]],
[[State]],
[[setState|setState()]]
[[setState|setState()]],
[[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 current functionality.

getState() Function

Introduced in version 1.3b40
Checks if the specified State is set on a token, return true(1) or false(0).

Usage

getState(state)
getState(state, id)

Parameters

  • state - The name of the state to check for.
  • id - The token id of the token to check for the state, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

Example

[if(getState("Dead"), "You are dead!", "You are not dead (yet!)")]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.