isBarVisible: Difference between revisions

Latest revision as of 19:08, 11 May 2024

isBarVisible() Function

• 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.

Usage

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.

Examples

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

Version Changes

1.5.7 - Added id and mapname parameter options.

Related Pages

@@ Line 1: / Line 1: @@
-{{stub}}
 {{MacroFunction
 |name=isBarVisible
+|version=1.3b46
 |description=
-Returns 1 if the [[Token:bar|Token Bar]] on the [[Token:Current Token|Current Token]] is visible or 0 if it is not.
+Returns {{true}} if the specified [[Introduction to Bars|Token Bar]] on the [[Current Token]] is visible, or {{false}} if it is not.
 |usage=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: vis = isBarVisible()]
+isBarVisible(bar)
-</source>
+isBarVisible(bar, tokenRef)
+isBarVisible(bar, tokenRef, mapname)
+</syntaxhighlight>
+'''Parameters'''
+{{param|bar|A string that contains the name of the bar that has its visibility checked.}}
+{{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=
+Displays {{code|The health bar is visible!}} if the bar named {{code|Health}} is set to visible; otherwise it displays {{code|The health bar is not visible!}}.
+<syntaxhighlight lang="mtmacro" line>
+[if(isBarVisible("Health")), code:
+{
+    The health bar is visible!
+};{
+    The health bar is not visible!
+}]
+</syntaxhighlight>
+Toggles the visibility of the bar named {{code|Fatigue}}.
+<syntaxhighlight lang="mtmacro" line>
+[h: setBarVisible("Fatigue", !isBarVisible("Fatigue"))]
+[h: abort(0)]
+</syntaxhighlight>
+|also=
+{{func|setBarVisible}},
+{{func|getBar}},
+{{func|setBar}}
+|changes=
+{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}}
 }}
-{{Clarify|
+==Related Pages==
-What is the syntax if the token has more than one bar visible? Will this return {{code|1}} if '''any''' bar is visible?
-}}
+* [[HP and Health Bars]]
-[[Category:Token Bar Function]]
+* [[bar.name|The <code>bar.name</code> special variable]]
+[[Category:Bar Function]]