Exports

nox-hud provides exports for controlling the HUD from other resources.

Client Exports

ToggleHUD

Toggle HUD visibility on or off.

exports['nox-hud']:ToggleHUD(show)

Parameters:

Example:

-- Hide HUD during cutscene
exports['nox-hud']:ToggleHUD(false)

-- Show HUD after cutscene
exports['nox-hud']:ToggleHUD(true)

IsHUDVisible

Check if the HUD is currently visible.

local isVisible = exports['nox-hud']:IsHUDVisible()

Returns:

Example:

-- Check visibility before toggling
if exports['nox-hud']:IsHUDVisible() then
    print("HUD is currently visible")
else
    print("HUD is currently hidden")
end

Usage Examples

Hide HUD During Phone Call

RegisterNetEvent('phone:answered')
AddEventHandler('phone:answered', function()
    exports['nox-hud']:ToggleHUD(false)
end)

RegisterNetEvent('phone:hungup')
AddEventHandler('phone:hungup', function()
    exports['nox-hud']:ToggleHUD(true)
end)

Hide HUD During Cutscenes

-- Start cutscene
function StartCutscene()
    exports['nox-hud']:ToggleHUD(false)
    -- Your cutscene code here
end

-- End cutscene
function EndCutscene()
    exports['nox-hud']:ToggleHUD(true)
end

Toggle HUD with Keybind

RegisterCommand('togglemyhud', function()
    local current = exports['nox-hud']:IsHUDVisible()
    exports['nox-hud']:ToggleHUD(not current)
end, false)

RegisterKeyMapping('togglemyhud', 'Toggle HUD', 'keyboard', 'F7')

Commands

nox-hud also provides built-in commands:

Last updated: January 28, 2026