Commands and Exports

Commands#

Garbage Job is played at the NPC, not from chat. Every action is a keypress or a target option, and the job panel holds everything else — there is nothing for players to bind or type.

A practice command for the cleaning minigame#

Adding a command to Config.CleanDumpster registers a chat command that opens the cleaning minigame on the spot, in front of the player — handy for feeling out the timer and the threshold while you tune them. A practice run never moves a route forward and never pays experience.

lua

Config.CleanDumpster = {
    duration = 45000,
    threshold = 0.90,
    patches = 5,
    bonusExperience = 15,
    command = 'clean',   -- /clean opens a practice run
}

Leave command out — the default — and no command is registered.

Commands and Exports — Garbage Job | Quasar Store | Quasar Store

openLeaderboard

Opens the Statistics view — the same one the panel's button opens, with all three rankings, the prizes and the last winners. It does nothing while Config.EnableLeaderboard is false.

lua

exports['qs-garbagejob']:openLeaderboard()

For example, a rankings board on a ped of your own:

lua

exports.ox_target:addLocalEntity(myPed, {
    {
        name = 'garbage_leaderboard',
        label = 'Garbage rankings',
        icon = 'fa-solid fa-trophy',
        onSelect = function()
            exports['qs-garbagejob']:openLeaderboard()
        end,
    },
})

From the server, open it on one player's screen with the client event:

lua

TriggerClientEvent('qs-garbagejob:openLeaderboard', source)

IsPlayerOnMission

Whether the server has a route assigned to that player right now. It is read from the server's own record — set when a route starts, cleared when it is paid, abandoned, or the player is removed or disconnects — so it is the answer to trust.

lua

local working = exports['qs-garbagejob']:IsPlayerOnMission(source)   -- true / false

For example, keeping a collector out of another job until they finish their route:

lua

RegisterNetEvent('myjobs:start', function()
    local src = source
    if exports['qs-garbagejob']:IsPlayerOnMission(src) then
        return -- finish the garbage route first
    end
    -- start your job here
end)

getOnDutyCount

How many players are working a route right now.

lua

local collectors = exports['qs-garbagejob']:getOnDutyCount()

-- e.g. a city-hall screen
lib.callback.register('cityhall:jobStats', function()
    return { garbage = exports['qs-garbagejob']:getOnDutyCount() }
end)

isPlayerOnDuty

Whether a player is on duty, as their own client last reported it. It is kept for scripts that already use it; for anything that pays or permits something, use IsPlayerOnMission, which the server decides on its own.

lua

local onDuty = exports['qs-garbagejob']:isPlayerOnDuty(source)   -- true / false

Commands#

A practice command for the cleaning minigame#

Commands and Exports

Commands#

A practice command for the cleaning minigame#

Client Exports#

Server Exports#

Network Events#

About the Messages#