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, tokenRef)
getState(state, tokenRef, mapRef)

Parameters

• state - The name of the state to check for.
• tokenRef - Either the token id or Token Name of the token to check for the state. Defaults to the Current Token.

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

• mapRef - The Name or ID of the map to find the token. Defaults to the current map.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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.