isBarVisible: Difference between revisions

Latest revision as of 19:08, 11 May 2024

• Introduced in version 1.3b46

Returns true(1) if the specified Token Bar on the Current Token is visible, or false(0) if it is not.

isBarVisible(bar)
isBarVisible(bar, tokenRef)
isBarVisible(bar, tokenRef, mapname)

Parameters

bar - A string that contains the name of the bar that has its visibility checked.
tokenRef - Either the token id or Token Name of the token which has its bar checked, defaults to the Current Token.
Note: This parameter can only be used in a Trusted Macro.
mapname - The name of the map to find the token. Defaults to the current map.

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.

Displays The health bar is visible! if the bar named Health is set to visible; otherwise it displays The health bar is not visible!.

[if(isBarVisible("Health")), code:
{
    The health bar is visible!
};{
    The health bar is not visible!
}]

Toggles the visibility of the bar named Fatigue.

[h: setBarVisible("Fatigue", !isBarVisible("Fatigue"))]
[h: abort(0)]

@@ Line 8: / Line 8: @@
 <syntaxhighlight lang="mtmacro" line>
 isBarVisible(bar)
-isBarVisible(bar, id)
+isBarVisible(bar, tokenRef)
-isBarVisible(bar, id, mapname)
+isBarVisible(bar, tokenRef, mapname)
 </syntaxhighlight>
 '''Parameters'''
 {{param|bar|A string that contains the name of the bar that has its visibility checked.}}
-{{param|id|The token {{code|id}} of the token which has its bar checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its bar checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
 {{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
+{{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.}}
 |examples=