esx_service

esx_service tracks which players of a job are on duty. Job resources such as esx_taxijob and esx_mechanicjob use it to cap the number of players in service, show how many colleagues are active and send a notification to everyone on duty.

OverviewCopy Anchor Link

InstallationCopy Anchor Link

ensure esx_service
# job resources that use it
ensure esx_taxijob

A service name is the job name, for example taxi. A player can only enter the service of their own job.

Server APICopy Anchor Link

All server events are local and protected: GetInvokingResource() must be set, so calls coming straight from a client are blocked and logged as Blocked external call.

esx_service:activateServiceCopy Anchor Link

Creates a service and sets its player limit. Call it once on resource start.

TriggerEvent('esx_service:activateService', name, max)

TriggerEvent('esx_service:activateService', 'taxi', Config.MaxInService)

A service that was never activated is created on first use with no limit.

esx_service:disableServiceCopy Anchor Link

Takes a player off duty.

TriggerEvent('esx_service:disableService', name, playerId)

esx_service:notifyAllInServiceCopy Anchor Link

Sends an advanced notification to everyone on duty in a service, except the sender. The sender's mugshot is used as the icon.

TriggerEvent('esx_service:notifyAllInService', notification, name, sender)

TriggerEvent('esx_service:notifyAllInService', {
    title = 'Dispatch',
    subject = 'Backup',
    msg = 'Officer needs assistance at Legion Square',
    iconType = 1,
}, 'police', source)

GlobalState countCopy Anchor Link

local onDuty = GlobalState.taxi or 0

The value updates on every enable, disable and disconnect.

Server callbacksCopy Anchor Link

Call these from the client with ESX.TriggerServerCallback, ESX.AwaitServerCallback or xLib.callback. See Callbacks.

ESX.TriggerServerCallback('esx_service:enableService', function(canTakeService, maxInService, inServiceCount)
    if canTakeService then
        ESX.ShowNotification('You are now on duty')
    else
        ESX.ShowNotification(('Service full: %s/%s'):format(inServiceCount, maxInService))
    end
end, 'taxi')

-- go off duty
ESX.TriggerServerCallback('esx_service:disableService', function() end, 'taxi')

-- check own duty state
local onDuty = ESX.AwaitServerCallback('esx_service:isInService', 'taxi')

Client eventCopy Anchor Link

esx_service:notifyAllInService (net, server to client) shows the notification. It is triggered by the server event above; you do not call it yourself.

Integration tipsCopy Anchor Link

• esx_service is separate from the onDuty field of the ESX job object. If you also use xPlayer.setJob(job, grade, onDuty), keep both in sync yourself.
• Players are removed from every service when they disconnect, but not when they change job. Call esx_service:disableService when you fire someone.
• Duty state does not survive a restart of esx_service.

Common issuesCopy Anchor Link

• enableService always returns false: the player's job name differs from the service name you pass.
• Count above the limit: activateService ran after players were already on duty, or with a different max. Activate on resource start.
• Old scripts use TriggerServerEvent('esx_service:disableService', ...): replace it with the callback.

RelatedCopy Anchor Link

• esx_taxijob
• esx_mechanicjob
• esx_policejob
• Create a job

Frequently asked questions