Documentation
Integrate the script with your server and connect it to your existing systems using the available developer API and events.
Returns the total number of players on duty for your job. The scoreboard uses this number for the Active Jobs panel.
exports('getOnDutyCount', function()
local count = 0
for _, duty in pairs(OnDuty) do
if duty then count = count + 1 end
end
return count
end)Returns
numberReturns whether a specific player is on duty. The scoreboard uses this for the On/Off Duty badge in the player list.
exports('isPlayerOnDuty', function(src)
return OnDuty[tostring(src)] == true
end)
Parameters
Parameter | Type | Description |
|---|---|---|
| number | Player server ID |
Returns
booleanBoth calls are wrapped in pcall on the scoreboard side, so a missing or failing export never breaks the scoreboard — it falls back to 0 and "off".
local OnDuty = {}
RegisterServerEvent('my-job:setDutyStatus', function(onDuty)
OnDuty[tostring(source)] = onDuty == true
end)
AddEventHandler('playerDropped', function()
OnDuty[tostring(source)] = nil
end)
-- 1) Total players on duty
exports('getOnDutyCount', function()
local count = 0
for _, duty in pairs(OnDuty) do
if duty then count = count + 1 end
end
return count
end)
-- 2) Is this player on duty?
exports('isPlayerOnDuty', function(src)
return OnDuty[tostring(src)] == true
end)Clearing the entry on playerDropped matters — without it, disconnected players keep inflating the count.
TriggerServerEvent('my-job:setDutyStatus', true) -- clock in
TriggerServerEvent('my-job:setDutyStatus', false) -- clock outPoint Config.DisplayedJobs at your resource:
my_job = {
order = 9,
label = "My Job",
onDutyExport = { resource = "my-jobresource", fn = "getOnDutyCount" },
playerDutyExport = { resource = "my-jobresource", fn = "isPlayerOnDuty" },
icon = "fa-solid fa-briefcase"
},Icons use Font Awesome classes.
Config.CurrentPoliceExport overrides the automatic police count, which otherwise counts every online player whose job is listed in Config.PoliceJobNames.
Point it at any export returning a number, and the heist unlock logic will use that value instead.
gradeExport in Config.PlayerJobs appends text after a job's label in the player list — a rank, a badge number, or anything else your job resource can return.
The Job Progress panel reads level and XP directly from each job resource's own table. For a job to appear there it needs:
A table with level and experience columns, keyed by the player identifier.
Its resource started — stopped resources are skipped entirely.
An entry in Config.JobsProgress whose baseExperience and growthFactor match the job script's own curve.
The identifier used is the player's framework identifier — identifier on ESX, citizenid on QBCore.
The bar is computed as:
totalLevelExperience = math.floor(baseExperience * (growthFactor ^ (level - 1)))If these values don't match the job script's own Config.LevelExperience, the level shown will be right but the percentage will be wrong.