Job Options

All job actions are formated as an array containing objects with the following properties.

Each job has its own config file. This file is located at escrow/jobs/<job_name>/config.lua.

Job Option

---

• active: boolean — If the job is currently active.

• label: string — The label (title) of the job shown to the user.

• description: string — A short description of the job.

• reward: JobReward — Rewards given when the job is completed.

  • exp: number — Experience points awarded.

  • money: number — Shared money rewarded.

  • unshared_amount: number — Money rewarded directly to the player, not shared with others.

• level: number — Minimum player level required to start this job.

• steps: JobStep[] — A list of steps needed to complete the job.

• requiredItems: RequiredItem[] — List of items needed to begin the job.

• cooldown: number — Time in seconds before the job can be started again.

• requiredJobName: string — Job name required in order to access this job.

• requiredGangName: string — Gang name required to start the job.

• teamSize: TeamSize — Team requirements to begin the job.

  • min: number — Minimum players needed.

  • max: number — Maximum players allowed.

---

Job Class <dev>

---@class Job
---@field active boolean -- if the job is currently active
---@field label string -- the label of the job
---@field description string -- the description of the job
---@field reward JobReward -- the reward for completing the job
---@field image string -- the image of the job
---@field information string -- additional information about the job
---@field level number -- the level required to start the job
---@field steps JobStep[] -- the steps required to complete the job
---@field requiredItems RequiredItem[] -- the items required to start the job
---@field name string -- the key name of the job
---@field game table
---@field blips table
---@field cooldown number -- the cooldown time for the job in seconds
---@field requiredJobName string -- the name of the job required to start this job
---@field requiredGangName string -- the name of the gang required to start this job
---@field teamSize TeamSize -- the size of the team required to start the job

---@class TeamSize
---@field min number -- minimum number of players required to start the job
---@field max number -- maximum number of players allowed to start the job

---@class JobReward
---@field exp number -- the experience points rewarded for completing the job
---@field money number -- the money rewarded for completing the job
---@field unshared_amount number -- the amount of unshared money rewarded for completing the job

---@class JobStepProgress
---@field target number -- the target progress for the step
---@field current number -- the current progress made in the step

---@class JobStep
---@field index number -- the index of the step in the job
---@field label string -- the label of the step
---@field progress JobStepProgress -- the progress of the step
---@field done boolean -- if the step is completed
---@field timeLimit number -- the time limit for completing the step in seconds
---@field endTime number -- the end time for the step in seconds since epoch

---@class RequiredItem
---@field label string -- the label of the required item
---@field itemName string -- the name of the required item
---@field count number -- the number of required items