setAllStates: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
 
(11 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Function setAllSates==
{{stub|Examples using new functionality.}}
Sets all of the [[Token:state|Token States]] of the [[Token:Current Token|Current Token]] to on (non zero) or off (0).
{{MacroFunction
|name=setAllStates
|version=1.3b40
|description=
Sets all of the [[State|States]] of a [[Token]] to on ({{true}}) or off ({{false}}).


===Usage===
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro">
[h: setAllStates(val)]
setAllStates(value)
</source>
setAllStates(value, tokenRef)
setAllStates(value, tokenRef, mapname)
</syntaxhighlight>
'''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|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=
Set all [[Token:state|Token States]] on
<syntaxhighlight lang="mtmacro" line>
[h: setAllStates(1)]
</syntaxhighlight>
Set all [[Token:state|Token States]] off
<syntaxhighlight lang="mtmacro" line>
[h: setAllStates(0)]
</syntaxhighlight>


|also=
[[State]], [[getState|getState()]], [[setState|setState()]]


===Examples===
|changes=
Set all [[Token:state|Token States]] on
{{change|1.3b51|Added {{code|id}} parameter option.}}
<source lang="mtmacro" line>
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
    [h: setAllStates(1)]
}}
</source>
[[Category:State Function]]
Set all [[Token:state|Token States]] off
<source lang="mtmacro" line>
    [h: setAllStates(0)]
</source>

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
Sets all of the States of a Token to on (true(1)) or off (false(0)).

Usage

setAllStates(value)
setAllStates(value, tokenRef)
setAllStates(value, tokenRef, mapname)

Parameter

  • value - If all states should be set on or off, true(1) or false(0).
  • tokenRef - Either the token id or 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

Set all Token States on 
[h: setAllStates(1)]

Set all Token States off 

[h: setAllStates(0)]

See Also

State, getState(), setState()

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=setAllStates&oldid=17894"