getAlwaysVisible: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=getAlwaysVisible |version=1.4.2.0 |description=returns the value of the corresponding setting for the token. Always visible is a VBL setting which can be...") |
m (Text replacement - "<source" to "<syntaxhighlight") |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 2: | Line 2: | ||
|name=getAlwaysVisible | |name=getAlwaysVisible | ||
|version=1.4.2.0 | |version=1.4.2.0 | ||
|description= | |description= | ||
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= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getAlwaysVisible([id]) | getAlwaysVisible([id]) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
Line 14: | Line 15: | ||
|example= | |example= | ||
< | <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()] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:VBL Function]] | [[Category:VBL Function]] |
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
) orfalse
(0
).id
- OPTIONAL: The tokenid
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()]