Client Events

These are the esx: events on the client. Some are sent by the server to update the local player (load, job, money, inventory), others are fired locally by es_extended when something happens in the game (death, spawn, entering a vehicle). The tables show the arguments, who fires the event and whether you may trigger it yourself.

OverviewCopy Anchor Link

Player lifecycleCopy Anchor Link

esx:playerLoadedCopy Anchor Link

Sent by the server, not secured. Fired once the character is loaded.

RegisterNetEvent('esx:playerLoaded', function(xPlayer, isNew, skin)
    ESX.PlayerData = xPlayer

    if xPlayer.job.name == 'police' then
        CreatePoliceBlips()
    end
end)

esx:onPlayerLogoutCopy Anchor Link

Secure, no arguments. Sent after the server logged the player out of the character (multicharacter). ESX.PlayerLoaded becomes false.

RegisterNetEvent('esx:onPlayerLogout', function()
    RemovePoliceBlips()
end)

esx:onPlayerSpawnCopy Anchor Link

Local, no arguments. Fired by ESX after the first spawn (non-multicharacter), and by other resources such as esx_multicharacter and esx_death after a character spawn or revive. ESX resets PlayerData.dead, restores saved health and armor on the first spawn and starts death detection.

AddEventHandler('esx:onPlayerSpawn', function()
    SetPedArmour(PlayerPedId(), 0)
end)

esx:onPlayerDeathCopy Anchor Link

Local, also sent to the server. Fired when ESX detects the death of the local ped.

AddEventHandler('esx:onPlayerDeath', function(data)
    if data.killedByPlayer then
        ESX.ShowNotification(('You were killed by player %s'):format(data.killerServerId), 'error')
    end
end)

esx:loadingScreenOffCopy Anchor Link

Local, no arguments. Fired after the first spawn when ESX shuts down the loading screen (non-multicharacter).

esx:restoreLoadoutCopy Anchor Link

Local, internal. Removes all weapons and gives back the weapons, tints, components and ammo from PlayerData.loadout. ESX fires it after spawn and when skinchanger loads a new model. Built-in inventory only.

esx:setPlayerDataCopy Anchor Link

Local. Fired by ESX.SetPlayerData with (key, val, last) for every PlayerData change. See Client PlayerData.

Player data updates (server to client)Copy Anchor Link

All of these are secure and update ESX.PlayerData through ESX.SetPlayerData.

RegisterNetEvent('esx:setAccountMoney', function(account)
    if account.name == 'money' then
        SendNUIMessage({ action = 'cash', value = account.money })
    end
end)

RegisterNetEvent('esx:setJob', function(job, lastJob)
    print(('Job changed from %s to %s'):format(lastJob.name, job.name))
end)

Inventory and weapons (built-in inventory)Copy Anchor Link

Secure. Not registered when Config.CustomInventory is set.

RegisterNetEvent('esx:addInventoryItem', function(item, count)
    if item == 'radio' and count == 1 then
        ESX.ShowNotification('You can now use /radio')
    end
end)

Notifications and commands (server to client)Copy Anchor Link

The notification events are harmless if faked locally; they only display text. From the server prefer xPlayer.showNotification(...).

Admin events (server to client)Copy Anchor Link

These are sent by the admin commands. They are not secured, so a client-side script could fire them locally.

Game state (local)Copy Anchor Link

ESX checks these values in a loop every 500 ms (vehicle, pause menu) or through the esx_lib cache (ped, weapon) and fires local events.

plate is the raw plate text with padding; trim it with ESX.Math.Trim. netId is the local handle when the vehicle is not networked.

AddEventHandler('esx:enteredVehicle', function(vehicle, plate, seat)
    if seat == -1 then
        ESX.ShowNotification(('Driving %s'):format(ESX.Math.Trim(plate)))
    end
end)

AddEventHandler('esx:pauseMenuActive', function(isActive)
    SendNUIMessage({ action = 'hud', visible = not isActive })
end)

Deprecated and removedCopy Anchor Link

RelatedCopy Anchor Link

• Server events
• Client PlayerData
• Client functions
• xPlayer

Frequently asked questions