setAlwaysVisible: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|version=1.4.2.0 | |version=1.4.2.0 | ||
|description= | |description= | ||
Turns the corresponding setting for the token on or off. ''' | 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= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setAlwaysVisible(value, [ | setAlwaysVisible(value, [tokenRef]) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|value|The value of the setting to set, {{true}} or {{false}}.}} | {{param|value|The value of the setting to set, {{true}} or {{false}}.}} | ||
{{param| | {{param|tokenRef|OPTIONAL:The name of the map to find the token for which you want to set this setting, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{Note|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= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setAlwaysVisible(1)] | [h: setAlwaysVisible(1)] | ||
[h: setAlwaysVisible(0, "Dragon")] | [h: setAlwaysVisible(0, "Dragon")] | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
[[Category:VBL Function]] | [[Category:VBL Function]] | ||
Latest revision as of 23:59, 23 May 2024
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) orfalse(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")]