API Reference

Exports

Client Exports

IsInviteOpen

Returns whether an invite UI is currently open.

luaCopy
exports['HCS_invite']:IsInviteOpen()

Prop	Type
return	boolean

PlayCheer

Plays the cheer animation towards another player.

luaCopy
exports['HCS_invite']:PlayCheer(otherServerId)

Prop	Type
otherServerId	number

Server Exports

SendJobInvite

Opens the legal job contract UI (Arbeitsvertrag) for a player.

luaCopy
exports['HCS_invite']:SendJobInvite(targetId, job, grade, senderId?)

Prop	Type
targetId	number
job	string
grade	number
senderId?	number (needed so decline can notify the sender)

SendFrakInvite

Opens the illegal faction invite UI for a player.

luaCopy
exports['HCS_invite']:SendFrakInvite(targetId, job, grade, senderId?)

Prop	Type
targetId	number
job	string
grade	number
senderId?	number (needed so decline can notify the sender)

SendJobInviteFrom / SendFrakInviteFrom

Aliases with explicit sender first.

luaCopy
exports['HCS_invite']:SendJobInviteFrom(senderId, targetId, job, grade)
exports['HCS_invite']:SendFrakInviteFrom(senderId, targetId, job, grade)

Prop	Type
senderId	number
targetId	number
job	string
grade	number

Events

Server Events

Send Job Invite

Server-local only (TriggerEvent from another server script).

luaCopy
TriggerEvent('HCS_invite:server:sendJobInvite', targetId, job, grade)
TriggerEvent('HCS_invite:server:sendJobInviteFrom', senderId, targetId, job, grade)

Prop	Type
targetId	number
job	string
grade	number
senderId	number

Send Frak Invite

luaCopy
TriggerEvent('HCS_invite:server:sendFrakInvite', targetId, job, grade)
TriggerEvent('HCS_invite:server:sendFrakInviteFrom', senderId, targetId, job, grade)

Prop	Type
targetId	number
job	string
grade	number
senderId	number

Custom Apply Job Hook

Triggered from shared/setjob.lua when no ESX/QB player object is available.

luaCopy
AddEventHandler('HCS_invite:applyJob', function(src, job, grade)
    -- your custom setjob logic
end)

Prop	Type
src	number
job	string
grade	number

Client Events

Open / Close

luaCopy
TriggerClientEvent('HCS_invite:open', targetId, payload)
TriggerClientEvent('HCS_invite:close', targetId)

Prop	Type
targetId	number
payload	table