UgCore.Jobs

Jobs, grades and duty.

Server Client Optional module. Requires characters.

Jobs are defined in config/jobs.lua, a data config. Every character has exactly one job and falls back to unemployed.

config/jobs.lua

return {
    unemployed = {
        label = 'Unemployed',
        grades = { { name = 'unemployed', label = 'Unemployed', salary = 0 } },
    },
    police = {
        label = 'Police',
        defaultDuty = false,
        grades = {
            { name = 'recruit', label = 'Recruit', salary = 100 },
            { name = 'officer', label = 'Officer', salary = 150 },
            { name = 'sergeant', label = 'Sergeant', salary = 200 },
            { name = 'chief', label = 'Chief', salary = 300, boss = true },
        },
    },
}

Grades are 1-based indexes into grades.

Server

Get

UgCore.Jobs.Get(source) -> UgAssignment?

UgAssignment · table

nil without a loaded character.

Hide fields

name · string

label · string

grade · integer

gradeName · string

gradeLabel · string

salary · integer

boss · boolean

onDuty · boolean

Set / SetGrade

UgCore.Jobs.Set(source, name, grade?) -> ok, errorCode
UgCore.Jobs.SetGrade(source, grade) -> ok, errorCode

MUST run in a thread. grade defaults to 1. Unknown jobs and grades return invalid_args. Jobs:BeforeSet MAY cancel.

SetDuty / IsOnDuty

UgCore.Jobs.SetDuty(source, onDuty) -> ok, errorCode
UgCore.Jobs.IsOnDuty(source) -> boolean

Exists / GetDefinition

UgCore.Jobs.Exists(name, grade?) -> boolean
UgCore.Jobs.GetDefinition(name) -> { label, grades, defaultDuty? }?

Client

UgCore.Jobs.Get() -> UgAssignment?
UgCore.Jobs.IsOnDuty() -> boolean

Read from the ug-core:Job statebag.

Events

• ug-core:Jobs:Changed with (source, job, previous)
• ug-core:Jobs:DutyChanged with (source, onDuty)

Example

local job = UgCore.Jobs.Get(source)

if not job or job.name ~= 'police' or not job.onDuty then
    return false, UgCore.Enums.Errors.NoPermission
end