Server Events

These are the esx: events you meet on the server. Most of them are local server events that es_extended fires so other resources can react, for example when a player loads, changes job or gets money. A second group are net events sent by clients, which you must treat as untrusted input.

OverviewCopy Anchor Link

Player lifecycleCopy Anchor Link

esx:playerLoadedCopy Anchor Link

Listen only. Fired after a character is loaded and the xPlayer object exists. Also fires for every character switch with multicharacter.

AddEventHandler('esx:playerLoaded', function(playerId, xPlayer, isNew)
    if isNew then
        xPlayer.addInventoryItem('phone', 1)
        xPlayer.showNotification('Welcome to the city!')
    end
end)

esx:playerDroppedCopy Anchor Link

Listen only. Fired when an xPlayer is removed: disconnect, logout or a stale session cleanup. Fired before the final save, so the xPlayer still exists.

AddEventHandler('esx:playerDropped', function(playerId, reason)
    local xPlayer = ESX.GetPlayerFromId(playerId)
    if xPlayer then
        print(('%s left (%s)'):format(xPlayer.getName(), reason))
    end
end)

esx:playerSavedCopy Anchor Link

Listen only. Fired after a player's row was written to the database (autosave every 10 minutes, on drop and manual saves).

esx:playerLogoutCopy Anchor Link

Server-only trigger. Trigger it from server code to log a player out of the current character. ESX saves and removes the xPlayer, then sends esx:onPlayerLogout to the client. Registered with AddEventHandler, so clients cannot trigger it.

TriggerEvent('esx:playerLogout', playerId, function()
    print(('Player %s is back at character selection'):format(playerId))
end)

esx:onPlayerJoinedCopy Anchor Link

Internal. Starts loading the player.

• Without multicharacter: client-sent net event with no arguments. ESX ignores it if the player is already loaded or loading.
• With multicharacter: local server event (playerId, char, data) triggered by the multicharacter resource.

esx:onPlayerDroppedCopy Anchor Link

Internal. Local server event (playerId, reason, cb) that runs the ESX drop and save routine. Use esx:playerLogout instead.

esx:onPlayerSpawnCopy Anchor Link

Client-sent (untrusted). Sent by the client after the first spawn. ESX only sets xPlayer.spawned = true.

Jobs and groupsCopy Anchor Link

esx:setJobCopy Anchor Link

Listen only. Fired after xPlayer.setJob.

AddEventHandler('esx:setJob', function(playerId, job, lastJob)
    if job.name == 'police' and lastJob.name ~= 'police' then
        exports.my_radio:GiveChannelAccess(playerId, 1)
    end
end)

esx:jobDataRefreshedCopy Anchor Link

Listen only. Fired when a player's job data was rebuilt after the job definition changed (for example after ESX.RefreshJob).

esx:setGroupCopy Anchor Link

Listen only. Fired after xPlayer.setGroup.

esx:jobsRefreshedCopy Anchor Link

Listen only. No arguments. Fired after all jobs were loaded from the database (ESX.RefreshJobs).

esx:jobRefreshedCopy Anchor Link

Listen only. Fired after one job was reloaded with ESX.RefreshJob.

esx:jobRemovedCopy Anchor Link

Listen only. Fired when a refreshed job no longer exists or has no grades. Players with that job are set to unemployed.

esx:jobCreatedCopy Anchor Link

Listen only. Fired after ESX.CreateJob created a job.

Money and inventoryCopy Anchor Link

esx:setAccountMoney / esx:addAccountMoney / esx:removeAccountMoneyCopy Anchor Link

Listen only. Fired by xPlayer.setAccountMoney, addAccountMoney and removeAccountMoney (also with ox_inventory).

AddEventHandler('esx:addAccountMoney', function(playerId, account, amount, reason)
    if account == 'black_money' and amount >= 100000 then
        print(('[audit] %s received %s dirty money (%s)'):format(playerId, amount, reason or 'no reason'))
    end
end)

esx:onAddInventoryItem / esx:onRemoveInventoryItemCopy Anchor Link

Listen only. Built-in inventory only. Fired after xPlayer.addInventoryItem / removeInventoryItem.

esx:playerInventoryCleared / esx:playerLoadoutClearedCopy Anchor Link

Listen only. Fired by the /clearinventory and /clearloadout admin commands.

VehiclesCopy Anchor Link

esx:createdExtendedVehicle / esx:deletedExtendedVehicleCopy Anchor Link

Listen only. Fired when an ExtendedVehicle object is created or deleted.

esx:changedExtendedVehiclePlateCopy Anchor Link

Listen only. Fired after an ExtendedVehicle plate change.

Events sent by clientsCopy Anchor Link

Handled by es_extendedCopy Anchor Link

These net events are handled by the built-in inventory (not registered when Config.CustomInventory is set). ESX validates and rate-limits them. Do not register your own handlers that trust their arguments.

Not handled by es_extendedCopy Anchor Link

The client sends these so other resources can use them. ESX itself registers no server handler. All arguments are client-controlled.

esx:onPlayerDeathCopy Anchor Link

RegisterNetEvent('esx:onPlayerDeath', function(data)
    local victim = source
    if type(data) ~= 'table' or not data.killedByPlayer then return end

    local killer = tonumber(data.killerServerId)
    if not killer or not ESX.GetPlayerFromId(killer) then return end

    local distance = #(GetEntityCoords(GetPlayerPed(victim)) - GetEntityCoords(GetPlayerPed(killer)))
    if distance > 300.0 then return end -- claim does not match server state

    print(('Player %s was killed by %s'):format(victim, killer))
end)

Vehicle eventsCopy Anchor Link

RegisterNetEvent('esx:enteredVehicle', function(plate, seat, displayName, netId)
    local vehicle = NetworkGetEntityFromNetworkId(netId)
    if vehicle == 0 or GetVehiclePedIsIn(GetPlayerPed(source), false) ~= vehicle then return end

    print(('%s entered %s (%s) in seat %s'):format(source, displayName, plate, seat))
end)

netId is the local entity handle when the vehicle is not networked, so always check the result of NetworkGetEntityFromNetworkId.

Deprecated and removedCopy Anchor Link

RelatedCopy Anchor Link

• Client events
• xPlayer
• Server functions
• Callbacks

Frequently asked questions