getState: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (22 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples using current functionality.}} | ||
{{MacroFunction | |||
|name=getState | |||
|version=1.3b40 | |||
|description= | |||
Checks whether the specified [[State]] is active on a token, returning {{true}} or {{false}}. | |||
|usage= | |||
< | <syntaxhighlight lang="mtmacro"> | ||
getState(state) | |||
</ | getState(state, tokenRef) | ||
getState(state, tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|state|The name of the state to check for.}} | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to check for the state. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
{{Note|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= | |||
< | <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]] | |||
Latest revision as of 23:59, 13 May 2024
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, tokenRef)
getState(state, tokenRef, mapRef)Parameters
state- The name of the state to check for.tokenRef- Either the tokenidor 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
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.