getAlwaysVisible

From RPTools Wiki
Revision as of 23:59, 13 May 2024 by Taustin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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([tokenRef])

Parameters

  • value - The value of the setting to set, true(1) or false(0).
  • tokenRef - OPTIONAL:Either the token id or Token Name 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

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.

Example

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