isBarVisible: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Completed the article.)
m (Corrected "examples" header.)
Line 12: Line 12:
{{param|bar|A string that contains the name of the bar that has its visibility checked.}}
{{param|bar|A string that contains the name of the bar that has its visibility checked.}}


|example=
|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!}}.
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>
<source lang="mtmacro" line>

Revision as of 11:44, 30 May 2009

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)

Parameters

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

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

See Also