Events

Server-side events XeroShield triggers after a server ban, global ban, kick, or warning has been successfully recorded. Use them for your own logging and integrations.

Each event provides the player server ID, a token, and a data table. Check the token against the xerotoken convar before processing the payload. Register handlers in a server-side script with AddEventHandler.

Optional drop delay

The server ban, global ban, and kick events provide delayDrop as a fourth argument. Call delayDrop(4000) to delay the player drop by 4 seconds. The maximum accepted value is 20000 ms (20 seconds).

Call it directly in the event handler, before any Wait, Citizen.Await, or asynchronous callback. If multiple handlers request a delay, the largest valid value is used; delays are not added together. Values outside 0–20000 and non-number values are ignored.

The warning event has no delayDrop argument because a warning does not drop the player.