setAllStates: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version, cleaned up formatting.) |
No edit summary |
||
| (9 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub}} | {{stub|Examples using new functionality.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=setAllStates | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
Sets all of the [[ | Sets all of the [[State|States]] of a [[Token]] to on ({{true}}) or off ({{false}}). | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro"> | ||
setAllStates(value) | setAllStates(value) | ||
</ | setAllStates(value, tokenRef) | ||
setAllStates(value, tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | '''Parameter''' | ||
{{param|value|If all states should be set on or off, {{true}} or {{false}}.}} | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token that should have its [[State|States]] set. 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.}} | |||
|examples= | |examples= | ||
Set all [[Token:state|Token States]] on | Set all [[Token:state|Token States]] on | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setAllStates(1)] | |||
</ | </syntaxhighlight> | ||
Set all [[Token:state|Token States]] off | Set all [[Token:state|Token States]] off | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setAllStates(0)] | |||
</ | </syntaxhighlight> | ||
|also= | |||
[[State]], [[getState|getState()]], [[setState|setState()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:State Function]] | [[Category:State Function]] | ||
Latest revision as of 23:59, 23 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 new functionality.
setAllStates() Function
• Introduced in version 1.3b40
Usage
setAllStates(value)
setAllStates(value, tokenRef)
setAllStates(value, tokenRef, mapRef)Parameter
value- If all states should be set on or off,true(1) orfalse(0).tokenRef- Either the tokenidor Token Name of the token that should have its States set. 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.
Examples
See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.