Epsilon HUD - API / Exports

A list of exports and events you can use to control the HUD from other scripts.

Client Exports

HUD Visibility

Client - Lua
-- Hide HUD
exports['epsilon-hud']:hideHUD(true)

-- Show HUD
exports['epsilon-hud']:hideHUD(false)

Bar Update

Client - Lua
-- Update the value of a specific bar
exports['epsilon-hud']:updateBar('stress', 75)

-- Parameters:
-- barName: 'health', 'armor', 'hunger', 'thirst', 'stress', 'oxygen'
-- value: 0-100 range

Notification

Client - Lua
exports['epsilon-hud']:showNotification({
    title = 'Title',
    message = 'Message content',
    type = 'success',    -- 'success', 'error', 'warning', 'info'
    duration = 5000      -- milliseconds
})

Events

Client Events

Server - Lua
-- Toggle HUD state
TriggerClientEvent('epsilon-hud:toggleHUD', source, false)

-- Add custom bar
TriggerClientEvent('epsilon-hud:addCustomBar', source, {
    name = 'stamina',
    label = 'Stamina',
    color = '#bc8cff',
    value = 100
})

-- Remove custom bar
TriggerClientEvent('epsilon-hud:removeCustomBar', source, 'stamina')

Export Reference Table

ExportSideParametersDescription
hideHUDClientbooleanHide/show HUD
updateBarClientstring, numberUpdate bar value
showNotificationClienttableShow notification
isHUDVisibleClient-Check if HUD is visible