API

To integrate HUD V2 with other scripts. You are on the right page!

Client Events

Toggle HUD

Exports:

---@param enabled boolean
exports["Elite-HUDV1"]:ToggleHUD(enabled) -- true or false

Exemple:

RegisterCommand("showHud", function()
    exports["Elite-HUDV1"]:ToggleHUD(true) 
end

Trigger:

---@param enabled boolean
TriggerEvent('hud:toggle', enabled) -- true or false

Exemple:

RegisterCommand("showHudTrigger", function()
    TriggerEvent('hud:toggle', true)
end

Toggle HUD Reward

Useful if the Config.RewardSystem config is set to true

Exports:

---@param enabled boolean
exports["Elite-HUDV1"]:ToggleReward(enabled) -- true or false

Exemple:

RegisterCommand("showRewardInHud", function()
    exports["Elite-HUDV1"]:ToggleReward(true) 
end

Trigger:

---@param enabled boolean
TriggerEvent('hud:toggleReward', enabled) -- true or false

Exemple:

RegisterCommand("showRewardInHudTrigger", function()
    TriggerEvent('hud:toggleReward', true)
end

Put Radio frequency in HUD

Trigger:

---@param enabled boolean
---@param frequency number
TriggerEvent('hud:setRadio', {enabled = bolean, frequency = number})

Exports:

---@param enabled boolean
---@param frequency number
exports["Elite-HUDV1"]:SetRadio(enabled, frequency) 

Last updated