SetHUDVisibilityFlags

Function Deprecated This function should no longer be used. This page has been left for historical documentation purposes only. This function has been deprecated as it has been replaced by an equivalent function in JohnnyGuitar NVSE. Use SetHUDVisibilityOverride instead.

A function added by the SUP NVSE Plugin.

Description

Sets specified flags to game HUD Visibility flags allowing to easily hide\show game UI elements.

Syntax

[help]

SetHUDVisibilityFlags iVisFlags:int

HUD Flags

kActionPoints = 0x1,// BIT - 0
kHitPoints = 0x2,// BIT - 1
kRadiationMeter = 0x4,// BIT - 2
kEnemyHealth = 0x8,// BIT - 3
kQuestReminder = 0x10,// BIT - 4
kRegionLocation = 0x20,// BIT - 5
kReticleCenter = 0x40,// BIT - 6
kSneakMeter = 0x80, // BIT - 7
kMessages = 0x100, // BIT - 8
kInfo = 0x200, // BIT - 9
kSubtibles = 0x400,// BIT - 10
kHotkeys = 0x800,// BIT - 11
kXpMeter = 0x1000,// BIT - 12
kBreathMeter = 0x2000,// BIT - 13
kExplosivePositioning = 0x4000,// BIT - 14
kCrippledLimbIndicator = 0x8000,// BIT - 15
kHardcoreMode = 0x10000,// BIT - 16

Example

SetHUDVisibilityFlags 0

Hides all UI elements on screen.

SetHUDVisibilityFlags 131071

Restores all UI elements on screen.

if GetBit CurrentFlags 9 == 1
  set CurrentFlags to ClearBit CurrentFlags, 9
  SetHUDVisibilityFlags CurrentFlags
endif

Checks if INFO HUD flag is already cleared. If not - clears it thus hiding crosshair prompt.

if GetBit CurrentFlags 9 == 0
    set CurrentFlags to SetBit CurrentFlags, 9
    SetHUDVisibilityFlags CurrentFlags
endif

Checks if INFO HUD flag is already set. If not - sets it thus showing crosshair prompt.

Notes

• Before setting flags you should always check their value with GetHUDVisibilityFlags, then set/clear a bit to retain compatibility with other mods.
• Hiding some flags might not disable UI elements, for instance radiation meter will still be visible until you exit\enter any menu after you walked into an irradiated area.

See Also

• GetHUDVisibilityFlags