es_extended

es_extended is the core resource of ESX Legacy. It loads characters from the database, creates the server-side xPlayer object, manages money accounts, jobs, items, weapons and permissions, and exposes all of this through the shared ESX object that every other ESX resource uses.

OverviewCopy Anchor Link

Getting the ESX objectCopy Anchor Link

There are two supported ways. Pick one per resource.

Option 1: imports.lua (recommended)Copy Anchor Link

fx_version "cerulean"
game "gta5"
lua54 "yes"

shared_script "@es_extended/imports.lua"

client_script "client/main.lua"
server_script "server/main.lua"

imports.lua sets a global ESX and adds extras:

• On the client, ESX.PlayerData and ESX.PlayerLoaded stay in sync automatically, and an optional global OnPlayerData(key, value, last) function is called on changes.
• On the server, ESX.Player(source) and ESX.ExtendedPlayers() return static players.
• ESX.require, ESX.load and ESX.loadJson load modules and JSON files when ox_lib is not installed. See require.

Option 2: the exportCopy Anchor Link

ESX = exports["es_extended"]:getSharedObject()

The export returns the ESX table at the moment you call it. Functions work normally, but data tables such as ESX.PlayerData on the client are not refreshed in your resource. Use getters like ESX.GetPlayerData() and ESX.GetJobs() instead.

Resource structureCopy Anchor Link

Server, client and sharedCopy Anchor Link

Keep authority on the server. The client may ask, but the server checks distance, money, job and items before changing anything.

Player lifecycleCopy Anchor Link

AddEventHandler("esx:playerLoaded", function(playerId, xPlayer, isNew)
    if isNew then
        xPlayer.addInventoryItem("phone", 1)
    end
end)

AddEventHandler("esx:playerDropped", function(playerId, reason)
    print(("Player %s left: %s"):format(playerId, reason))
end)

All events with their arguments: server events and client events.

Explore es_extendedCopy Anchor Link

RelatedCopy Anchor Link

• Your first ESX resource
• Coding practices
• esx_lib
• Convert old ESX scripts

Frequently asked questions