setAlwaysVisible

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

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

Parameters

  • value - The value of the setting to set, true(1) or false(0).
  • tokenRef - OPTIONAL:The name of the map to find 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

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