API-Referenz

Exports

Client-Exports

IsInviteOpen

Gibt zurück, ob gerade eine Einladung offen ist.

lua
exports['HCS_invite']:IsInviteOpen()

Prop	Typ
return	boolean

PlayCheer

Spielt die Jubel-Animation in Richtung eines anderen Spielers ab.

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

Prop	Typ
otherServerId	number

Server-Exports

SendJobInvite

Öffnet für einen Spieler den Vertrag für einen legalen Job.

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

Prop	Typ
targetId	number
job	string
grade	number
senderId?	number (nötig, damit der Absender bei einer Ablehnung benachrichtigt wird)

SendFrakInvite

Öffnet für einen Spieler die Einladung in eine illegale Fraktion.

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

Prop	Typ
targetId	number
job	string
grade	number
senderId?	number (nötig, damit der Absender bei einer Ablehnung benachrichtigt wird)

SendJobInviteFrom / SendFrakInviteFrom

Varianten mit dem Absender als erstem Parameter.

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

Prop	Typ
senderId	number
targetId	number
job	string
grade	number

Events

Server-Events

Job-Einladung senden

Nur serverintern (TriggerEvent aus einem anderen Server-Script).

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

Prop	Typ
targetId	number
job	string
grade	number
senderId	number

Fraktions-Einladung senden

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

Prop	Typ
targetId	number
job	string
grade	number
senderId	number

Client-Events

Öffnen / Schließen

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

Prop	Typ
targetId	number
payload	table

Standalone: Job setzen

Unter Standalone setzt HCS_invite den angenommenen Job über CustomBridge.SetJob in HCS_lib/shared/functions.lua. Das frühere Event HCS_invite:applyJob gibt es nicht mehr.

lua
function CustomBridge.SetJob(src, job, grade)
    -- deine Logik, bei Erfolg true zurückgeben
end

Prop	Typ
src	number
job	string
grade	number
return	boolean

ZurückInstallation

WeiterInstallation