setAllStates: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples using new functionality.}} | {{stub|Examples using new functionality.}} | ||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=setAllStates | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro"> | ||
setAllStates(value) | setAllStates(value) | ||
setAllStates(value, tokenRef) | |||
setAllStates(value, tokenRef, mapname) | |||
setAllStates(value, | </syntaxhighlight> | ||
setAllStates(value, | |||
</ | |||
'''Parameter''' | '''Parameter''' | ||
{{param|value|If all states should be set on or off, {{true}} or {{false}}.}} | {{param|value|If all states should be set on or off, {{true}} or {{false}}.}} | ||
{{param| | {{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|mapname|The name of the map | {{param|mapname|The name 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)] | [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)] | [h: setAllStates(0)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
[[State]], | [[State]], [[getState|getState()]], [[setState|setState()]] | ||
[[getState|getState()]], | |||
[[setState|setState()]] | |||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{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 17:05, 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, mapname)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.
mapname- The name 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.