getState: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version, cleaned up formatting.) |
m (Text replacement - "source>" to "syntaxhighlight>") |
||
| (15 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub}} | {{stub|Examples using current functionality.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name=getState | |name=getState | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
Checks whether the specified [[State]] is active on a token, returning {{true}} or {{false}}. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro"> | ||
getState(state) | getState(state) | ||
</ | getState(state, id) | ||
''' | getState(state, id, mapname) | ||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{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|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[if(getState("Dead"), "You are dead!", "You are not dead (yet!)")] | [if(getState("Dead"), "You are dead!", "You are not dead (yet!)")] | ||
</ | </syntaxhighlight> | ||
|also= | |||
[[State]], [[setState|setState()]], [[setAllStates|setAllStates()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:State Function]] | |||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 19:04, 14 March 2023
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 tokenidof 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
idparameter option. - 1.5.4 - Added
mapnameparameter option.