isBarVisible
(Redirected from IsBarVisible)
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 tokenid
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)]
See Also
Version Changes
- 1.5.7 - Added
id
andmapname
parameter options.