Create a Job

To create a job in ESX Legacy, add one row to the jobs table and one row per rank to the job_grades table, then reload the jobs with /refreshjobs (or restart the server). From a script you can do the same at runtime with ESX.CreateJob. A job only becomes a "company" with a bank account and boss menu when you also register it with esx_society.

OverviewCopy Anchor Link

ESX loads all jobs once when the database is ready. A job that has no rows in job_grades is skipped with a warning, and a player whose saved job or grade does not exist is moved to unemployed grade 0 when they load.

How ESX stores jobsCopy Anchor Link

The jobs table holds one row per job:

The job_grades table holds the ranks:

See Database schema for every table ESX uses.

Create the job with SQLCopy Anchor Link

This is the most common way and works on any ESX Legacy server.

INSERT INTO `jobs` (`name`, `label`, `type`, `whitelisted`) VALUES
  ('bahamas', 'Bahama Mamas', 'civ', 1);

INSERT INTO `job_grades` (`job_name`, `grade`, `name`, `label`, `salary`, `skin_male`, `skin_female`) VALUES
  ('bahamas', 0, 'recruit',  'Recruit',  20,  '{}', '{}'),
  ('bahamas', 1, 'barman',   'Barman',   40,  '{}', '{}'),
  ('bahamas', 2, 'manager',  'Manager',  60,  '{}', '{}'),
  ('bahamas', 3, 'boss',     'Owner',    100, '{}', '{}');

refreshjobs

setjob 1 bahamas 0

Create a job from a script with ESX.CreateJobCopy Anchor Link

If your resource ships its own job, create it at runtime instead of asking server owners to run SQL. ESX.CreateJob inserts the job and its grades in one transaction and adds them to ESX.Jobs immediately, so no /refreshjobs is needed.

ESX.CreateJob(name, label, grades, jobType)

Returns: boolean, true when the rows were inserted.

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

CreateThread(function()
    if ESX.DoesJobExist('bahamas', 0) then
        return
    end

    local ok = ESX.CreateJob('bahamas', 'Bahama Mamas', {
        { grade = 0, name = 'recruit', label = 'Recruit', salary = 20 },
        { grade = 1, name = 'barman',  label = 'Barman',  salary = 40 },
        { grade = 2, name = 'manager', label = 'Manager', salary = 60 },
        { grade = 3, name = 'boss',    label = 'Owner',   salary = 100 },
    }, 'civ')

    if not ok then
        print('[bahamas] could not create the job, see the es_extended log above')
    end
end)

Behavior worth knowing:

• If the job already exists, only grades that do not exist yet are inserted. The existing label and type are kept.
• If the job and all grades already exist, it prints an error and returns false. Guard the call with ESX.DoesJobExist as above to keep the console clean.
• On success it fires the server event esx:jobCreated with (name, job).
• ESX.DoesJobExist and ESX.GetJobs wait until jobs are loaded, so call them from a thread, not at the top level of a file.

Reload a single jobCopy Anchor Link

After changing a salary or label directly in the database, ESX.RefreshJob(jobName) reloads just that job and updates every online player who has it (xPlayer.refreshJob()). If the job no longer exists or has no grades, online players with that job are set to unemployed.

ESX.RefreshJob('bahamas')

Change a player's job in codeCopy Anchor Link

local xPlayer = ESX.GetPlayerFromId(source)
xPlayer.setJob('bahamas', 1)          -- on duty by default (Config.DefaultJobDuty)
xPlayer.setJob('bahamas', 1, false)   -- explicitly off duty

setJob triggers the server event esx:setJob with (source, job, lastJob) and the client event esx:setJob with (job, lastJob). It also writes the job to the player's state bag (Player(source).state.job). React to job changes on the client like this:

RegisterNetEvent('esx:setJob', function(job, lastJob)
    if job.name == 'bahamas' then
        print(('Now working as %s (%s)'):format(job.grade_label, job.label))
    end
end)

The job table contains name, label, type, onDuty, grade, grade_name, grade_label, grade_salary, skin_male and skin_female. Full method list: xPlayer.

Add a society (company account and boss menu)Copy Anchor Link

A society gives the job a shared bank account, employee management (hire, fire, promote) and optionally money washing. It needs esx_society and esx_addonaccount, started before your job resource.

INSERT INTO `addon_account` (`name`, `label`, `shared`) VALUES
  ('society_bahamas', 'Bahama Mamas', 1);

TriggerEvent('esx_society:registerSociety', 'bahamas', 'Bahama Mamas',
    'society_bahamas', 'society_bahamas', 'society_bahamas', { type = 'private' })

TriggerEvent('esx_society:openBossMenu', 'bahamas', function()
    ESX.CloseContext()
end, { wash = false })

With Config.EnableSocietyPayouts = true in es_extended, salaries are paid from the society account instead of being created out of thin air. See Money and accounts.

Common issuesCopy Anchor Link

RelatedCopy Anchor Link

• xPlayer reference
• esx_society
• Money and accounts
• Database schema
• Admin permissions

Frequently asked questions