Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apex-services.site/llms.txt

Use this file to discover all available pages before exploring further.

Source: apex-ffa/hooks.lua (unencrypted).

​
Server hooks

Default — group is in Config.AdminGroups.
Return true to block the player from joining a zone / lobby. Default false.
Default DropPlayer(source, reason). Wire to your anti-cheat ban resource.
Default xPlayer.addInventoryItem(item, count or 1).
Default — UPDATE users SET position = ? WHERE identifier = ? (ESX legacy).
Default — SELECT firstname, lastname FROM users WHERE identifier = ?.
Per-kill hook. killerId may be nil for suicide/environment.
Lobby-end hook for quest systems / webhooks.
Default TriggerClientEvent('esx_ambulancejob:revive', source).
Default TriggerClientEvent('esx:showNotification', source, message).

​
Client hooks

Default lib.showTextUI / lib.hideTextUI.
Default ESX.ShowNotification, falls back to lib.notify.
Called when entering / leaving a zone or lobby. Use to integrate with custom_mode / saltychat / dpemotes.
Default no-op.
Default false. Return true if the local player currently has a combat / death timeout.
Default — IsEntityDead / IsPedDeadOrDying / LocalPlayer.state.isDead.
Default — toggles ox_inventory:weaponWheel and the invBusy / invHotkeys state bags.