API Reference

Exports

Client Exports

Notify

Start a Notification.

luaCopy
exports['HCS_hud']:Notify(title, message, type, timeout)

Prop	Type
title	string
message	string
type	string (success, info, warning, error)
timeout?	number

Announce

Start an Announcement (local only).

luaCopy
exports['HCS_hud']:Announce(title, message, timeout)

Prop	Type
title	string
message	string
timeout?	number

Teamchat

Start a Teamchat Notification (local only).

luaCopy
exports['HCS_hud']:Teamchat(title, badge, message, timeout)

Prop	Type
title	string
badge	string
message	string
timeout?	number

HideHud

Hides or shows the Hud.

luaCopy
exports['HCS_hud']:HideHud(hide)

Prop	Type
hide	boolean

HelpNotify

Shows the Help Notify. This must be called every tick.

luaCopy
exports['HCS_hud']:HelpNotify(message, key)

Prop	Type
message	string
key?	string

ShowHelpNotify

Shows the Help Notify. This must not be called every tick.

luaCopy
exports['HCS_hud']:ShowHelpNotify(message, key)

Prop	Type
message	string
key?	string

HideHelpNotify

Hides the current Help Notify.

luaCopy
exports['HCS_hud']:HideHelpNotify()

StartProgressbar

Starts a Progressbar.

luaCopy
exports['HCS_hud']:StartProgressbar(ms, name)

Prop	Type
ms	number
name?	string

StopProgressbar

Stops the current Progressbar.

luaCopy
exports['HCS_hud']:StopProgressbar()

UpdateHud

Updates core HUD values (partial patch).

luaCopy
exports['HCS_hud']:UpdateHud(data)

Prop	Type
data	table

Common fields: players, id, job, cash, bank, transactions, voice, radio, hunger, thirst, date, time.

SetStaff

Updates staff counters.

luaCopy
exports['HCS_hud']:SetStaff(data)

Prop	Type
data	table (teamler, einreise)

SetVehicle

Updates the speedometer / vehicle state.

luaCopy
exports['HCS_hud']:SetVehicle(data)

Prop	Type
data	table (inVehicle, speed, fuel, maxFuel?)

SetWeapon

Updates the weapon display.

luaCopy
exports['HCS_hud']:SetWeapon(data)

Prop	Type
data	table (visible, label, ammo, reserve, image?)

SetRadioList

Updates the radio list.

luaCopy
exports['HCS_hud']:SetRadioList(list)

Prop	Type
list	table ({ id, name, talking }[])

Server Exports

Notify

luaCopy
exports['HCS_hud']:Notify(target, title, message, type, timeout)

Prop	Type
target	number (player id or -1 for all)
title	string
message	string
type	string
timeout?	number

Announce

Broadcasts an announcement to all players.

luaCopy
exports['HCS_hud']:Announce(title, message, timeout)

Prop	Type
title	string
message	string
timeout?	number

Teamchat

Sends a teamchat toast to players with Teamchat permission.

luaCopy
exports['HCS_hud']:Teamchat(title, badge, message, timeout)

Prop	Type
title	string
badge	string
message	string
timeout?	number

HideHud

luaCopy
exports['HCS_hud']:HideHud(target, hide)

Prop	Type
target	number
hide	boolean

UpdateHud

luaCopy
exports['HCS_hud']:UpdateHud(target, data)

Prop	Type
target	number
data	table

SetStaff

luaCopy
exports['HCS_hud']:SetStaff(target, data)

Prop	Type
target	number
data	table

SetVehicle

luaCopy
exports['HCS_hud']:SetVehicle(target, data)

Prop	Type
target	number
data	table

SetWeapon

luaCopy
exports['HCS_hud']:SetWeapon(target, data)

Prop	Type
target	number
data	table

SetRadioList

luaCopy
exports['HCS_hud']:SetRadioList(target, list)

Prop	Type
target	number
list	table

SetEinreiseCount

Sets the Einreise counter (trusted server call).

luaCopy
exports['HCS_hud']:SetEinreiseCount(count)

Prop	Type
count	number

HasAccess

Checks whether a player may use a permission key (Announce / Teamchat).

luaCopy
exports['HCS_hud']:HasAccess(src, key)

Prop	Type
src	number
key	string
return	boolean

Events

Client Events

Notify

luaCopy
TriggerEvent('HCS_hud:notify', title, message, type, timeout)
TriggerClientEvent('HCS_hud:notify', source, title, message, type, timeout)

Prop	Type
title	string
message	string
type	string
timeout?	number

Announce

luaCopy
TriggerEvent('HCS_hud:announce', title, message, timeout)
TriggerClientEvent('HCS_hud:announce', source, title, message, timeout)

Prop	Type
title	string
message	string
timeout?	number

Teamchat

luaCopy
TriggerEvent('HCS_hud:teamchat', title, badge, message, timeout)
TriggerClientEvent('HCS_hud:teamchat', source, title, badge, message, timeout)

Prop	Type
title	string
badge	string
message	string
timeout?	number

HideHud

luaCopy
TriggerEvent('HCS_hud:hidehud', hide)
TriggerClientEvent('HCS_hud:hidehud', source, hide)

Prop	Type
hide	boolean

HelpNotify

Shows the Help Notify (every tick).

luaCopy
TriggerEvent('HCS_hud:helpNotify', message, key)
TriggerClientEvent('HCS_hud:helpNotify', source, message, key)

Prop	Type
message	string
key?	string

ShowHelpNotify

Shows the Help Notify (sticky).

luaCopy
TriggerEvent('HCS_hud:showHelpNotify', message, key)
TriggerClientEvent('HCS_hud:showHelpNotify', source, message, key)

Prop	Type
message	string
key?	string

HideHelpNotify

luaCopy
TriggerEvent('HCS_hud:hideHelpNotify')
TriggerClientEvent('HCS_hud:hideHelpNotify', source)

StartProgressbar

luaCopy
TriggerEvent('HCS_hud:startProgressbar', ms, name)
TriggerClientEvent('HCS_hud:startProgressbar', source, ms, name)

Prop	Type
ms	number
name?	string

StopProgressbar

luaCopy
TriggerEvent('HCS_hud:stopProgressbar')
TriggerClientEvent('HCS_hud:stopProgressbar', source)

UpdateHud

luaCopy
TriggerEvent('HCS_hud:updateHud', data)
TriggerClientEvent('HCS_hud:updateHud', source, data)

Prop	Type
data	table

SetStaff

luaCopy
TriggerEvent('HCS_hud:setStaff', data)
TriggerClientEvent('HCS_hud:setStaff', source, data)

Prop	Type
data	table

SetVehicle

luaCopy
TriggerEvent('HCS_hud:setVehicle', data)
TriggerClientEvent('HCS_hud:setVehicle', source, data)

Prop	Type
data	table

SetWeapon

luaCopy
TriggerEvent('HCS_hud:setWeapon', data)
TriggerClientEvent('HCS_hud:setWeapon', source, data)

Prop	Type
data	table

SetRadioList

luaCopy
TriggerEvent('HCS_hud:setRadioList', list)
TriggerClientEvent('HCS_hud:setRadioList', source, list)

Prop	Type
list	table

Server Events

Announce

luaCopy
TriggerServerEvent('HCS_hud:server:announce', title, message, timeout)

Prop	Type
title	string
message	string
timeout?	number

Teamchat

luaCopy
TriggerServerEvent('HCS_hud:server:teamchat', title, badge, message, timeout)

Prop	Type
title	string
badge	string
message	string
timeout?	number