isBarVisible: Difference between revisions

Revision as of 18:17, 9 October 2019

• 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, id)
isBarVisible(bar, id, mapname)

Parameters

bar - A string that contains the name of the bar that has its visibility checked.
id - The token id 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.

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: @@
 <source lang="mtmacro" line>
 isBarVisible(bar)
+isBarVisible(bar, id)
+isBarVisible(bar, id, mapname)
 </source>
 '''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|mapname|The name of the map to find the token.  Defaults to the current map.}}
 |examples=
@@ Line 33: / Line 37: @@
 {{func|getBar}},
 {{func|setBar}}
+|changes=
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter option.}}
 }}
 [[Category:Bar Function]]