setAlwaysVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(5 intermediate revisions by 4 users not shown)
Line 2: Line 2:
|name=setAlwaysVisible
|name=setAlwaysVisible
|version=1.4.2.0
|version=1.4.2.0
|description=turns the corresponding setting for the token on or off.
|description=
Turns the corresponding setting for the token on or off.  This modifies the '''Visible over FoW''' VBL setting on the the VBL tab of the Edit Token dialog.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setAlwaysVisible(value, [id])
setAlwaysVisible(value, [id])
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|value|The value of the setting to set, {{code|true}}({{code|1}}) or {{code|false}}({{code|0}}).}}
{{param|value|The value of the setting to set, {{true}} or {{false}}.}}
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set this setting, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|id|OPTIONAL: The token {{code|id}} of the token for which you want to set this setting, defaults to the [[Current Token]]. {{TrustedParameter}} }}


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: setAlwaysVisible(1)]
[h: setAlwaysVisible(1)]
[h: setAlwaysVisible(0, "Dragon")]
[h: setAlwaysVisible(0, "Dragon")]
</source>
</syntaxhighlight>
}}
}}
[[Category:VBL Function]]
[[Category:VBL Function]]

Revision as of 21:09, 14 March 2023

setAlwaysVisible() Function

Introduced in version 1.4.2.0
Turns the corresponding setting for the token on or off. This modifies the Visible over FoW VBL setting on the the VBL tab of the Edit Token dialog.

Usage

setAlwaysVisible(value, [id])

Parameters

  • value - The value of the setting to set, true(1) or false(0).
  • id - OPTIONAL: The token id of the token for which you want to set this setting, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

Example

[h: setAlwaysVisible(1)]
[h: setAlwaysVisible(0, "Dragon")]