setAllStates: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Typo)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub|Examples using new functionality.}}
{{stub|Examples using new functionality.}}
{{MacroFunction
{{MacroFunction
|name=setAllSates
|name=setAllStates
|version=1.3b40
|version=1.3b40
|description=
|description=
Line 7: Line 7:


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


|also=
|also=

Latest revision as of 01:19, 10 February 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, id)
setAllStates(value, id, mapname)

Parameter

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

Examples

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

Set all Token States off

[h: setAllStates(0)]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.