getState: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<source lang="mtmacro">
getState(state)
getState(state)
</source>
<source lang="mtmacro" line>
getState(state, id)
getState(state, id)
</source>
<source lang="mtmacro" line>
getState(state, id, mapname)
getState(state, id, mapname)
</source>
</source>
'''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]]. {{TrustedParameter}} }}
{{param|id|The token {{code|id}} of the token to check for the state.  Defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map where the token is, defaults to the current map.}}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


|example=
|example=

Revision as of 21:40, 14 August 2019

 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 to find the token. Defaults to the current map.

Example

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

See Also

Version Changes

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