getState

 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 whether the specified State is active on a token, returning true(1) or false(0).

Usage

getState(state)

getState(state, id)

getState(state, id, mapname)

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. 

• mapname - The name of the map where the token is, defaults to the current map.

Example

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

See Also

State,

setState(),

setAllStates()

Version Changes

• 1.3b51 - Added id parameter option.
• 1.5.4 - Added mapname parameter option.