getAlwaysVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Text replacement - "source>" to "syntaxhighlight>")
m (Text replacement - "<source" to "<syntaxhighlight")
Line 6: Line 6:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getAlwaysVisible([id])
getAlwaysVisible([id])
</syntaxhighlight>
</syntaxhighlight>
Line 15: Line 15:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
The Always Visible setting for Dragon is currently set to: [r: getAlwaysVisible("Dragon")]
The Always Visible setting for Dragon is currently set to: [r: getAlwaysVisible("Dragon")]
[h, token("Dragon"): isVisible = getAlwaysVisible()]
[h, token("Dragon"): isVisible = getAlwaysVisible()]

Revision as of 17:48, 14 March 2023

getAlwaysVisible() Function

Introduced in version 1.4.2.0
Returns the value of the corresponding setting for the token. Always Visible is a VBL setting which can be found in the Edit... menu of the token under the VBL tab.

Usage

getAlwaysVisible([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

The Always Visible setting for Dragon is currently set to: [r: getAlwaysVisible("Dragon")]
[h, token("Dragon"): isVisible = getAlwaysVisible()]