HudBarGetVisible

This article is incomplete. You can help by filling in any blank descriptions. Further information might be found in a section of the discussion page. Please remove this message when no longer necessary.

A function added by the SUP NVSE Plugin.

Description

Returns if Bar UI element or Bar itself is visible.

Syntax

[help]

(success:int) HudBarGetVisible barName:string iElement:int iModIndex:int 

Or:

(success:int) HBGetVisible barName:string iElement:int iModIndex:int

Example

set iVisible to HudBarGetVisible "BarName" 0

Will return visibility of Meter of "BarName"

set iVisible to HudBarGetVisible "BarNameFromOtherMod" 0 10

Will return visibility of Meter of "BarNameFromOtherMod", Bar mod origin index is 10.

Elements

0 - Meter;
1 - Frame;
3 - ImageEx;
10 - HUD BAR.

Notes

• Element 10 will return "-1"(if Bar is currently hidden i.e. if it's set to be hidden in First person), "0" if bar is hidden by you viaHudBarShowBarm or "1" if Bar is visible.

See Also

• HudBarSetVisible
• HudBarShowBar
• HudBarSetBarTrait
• ... and more in the SUP HUD Bar Functions category.