setAlwaysVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
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. Always visible is a VBL setting which can be found in the edit menu of the token under the VBL tab.  
|description=
Turns the corresponding setting for the token on or off. '''Always Visible''' is a VBL setting which can be found in the '''Edit...''' menu of the token under the VBL tab.  


|usage=
|usage=
Line 10: Line 11:


'''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}} }}



Revision as of 04:45, 7 March 2019

setAlwaysVisible() Function

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

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")]