getState: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
Line 12: | Line 12: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getState(state, id) | getState(state, id) | ||
</source> | |||
<source lang="mtmacro" line> | |||
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.}} | |||
|example= | |example= |
Revision as of 20:11, 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
Usage
getState(state)
getState(state, id)
getState(state, id, mapName)
Parameters
state
- The name of the state to check for.id
- The tokenid
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.
Example
[if(getState("Dead"), "You are dead!", "You are not dead (yet!)")]
See Also
Version Changes
- 1.3b51 - Added
id
parameter option.