isBarVisible: Difference between revisions

Revision as of 11:41, 30 May 2009

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

Parameters

bar - A string that contains the name of the bar that has its visibility checked.

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 1: / Line 1: @@
-{{stub}}
 {{MacroFunction
 |name=isBarVisible
 |version=1.3b46
 |description=
-Returns 1 if the [[Token:bar|Token Bar]] specified by "name" on the [[Current Token]] is visible, or 0 if it is not.
+Returns {{true}} if the specified [[Token Bar]] on the [[Current Token]] is visible, or {{false}} if it is not.
 |usage=
 <source lang="mtmacro" line>
-isBarVisible(name)
+isBarVisible(bar)
 </source>
-}}
+'''Parameters'''
-{{Clarify|
+{{param|bar|A string that contains the name of the bar that has its visibility checked.}}
-What is the syntax if the token has more than one bar visible? Will this return {{code|1}} if '''any''' bar is visible?
+|example=
+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!}}.
+<source lang="mtmacro" line>
+[if(isBarVisible("Health"), code:
+{
+    The health bar is visible!
+};{
+    The health bar is not visible!
+}]
+</source>
+Toggles the visibility of the bar named {{code|Fatigue}}.
+<source lang="mtmacro" line>
+[h: setBarVisible("Fatigue", !isBarVisible("Fatigue"))]
+[h: abort(0)]
+</source>
+|also=
+{{func|setBarVisible}},
+{{func|getBar}},
+{{func|setBar}}
 }}
 [[Category:Bar Function]]