API Reference

Reference for developers integrating another resource with oxide-animalcontroljob. Everything here is a server-side export; there are no client exports. If you just run the resource as a server owner, you don't need anything on this page.

Server Exports

All exports are called on the server.

IsOnShift

Tells you whether a player is currently on an animal control shift. Use it to stop a player from starting another job while they're already working this one.

local onShift = exports['oxide-animalcontroljob']:IsOnShift(source)

Parameters:

Returns: boolean — true from the moment the player clocks in until the shift ends, whether they clock out, log out or disconnect. false otherwise, including for an id that isn't a player.

A player who joined someone else's shift through a crew invite counts as on shift too.

GetSetting

Reads one of the resource's database-backed settings, keyed by the setting name without the Config. prefix.

local maxSlots = exports['oxide-animalcontroljob']:GetSetting('MaxSlotsPerLocation')

Parameters: key (string) — the setting name.

Returns: any — the current value.

SetSetting

Changes one of the resource's settings.

local ok = exports['oxide-animalcontroljob']:SetSetting('uniformsEnabled', true)

Parameters: key (string), value (any) — the setting name and its new value.

Returns: boolean — true when the change was applied. The change is live: the server uses it right away, it saves to the database, and it syncs to clients. It persists across restarts.

Returns false if the resource hasn't finished loading its settings yet, or if the value can't be stored (for example, a number that isn't finite).

See How Settings Work for how the database-backed settings relate to the config files.

GetInfo

The offices, whether each has room for another worker, and the base pay. Read-only.

local info = exports['oxide-animalcontroljob']:GetInfo()

Returns: table:

GetShift

A player's shift as the job holds it now. Read-only.

local shift = exports['oxide-animalcontroljob']:GetShift(source)

Parameters: source (number) — the player's server id.

Returns: table or false — false when the player is not on a shift; otherwise:

GetProgression

A player's level with this job. Read-only: a character who has never worked the job reads as level 1, and no record is created.

local progression = exports['oxide-animalcontroljob']:GetProgression(source)

Parameters: source (number) — the player's server id.

Returns: table or false — false when the player has no character; otherwise:

SetUpdateHandler

Lets another resource, such as a phone app, show this job's shift updates itself. While a handler is set and its resource runs, each update goes to it first: the messages the job sends to the phone when usePhone is on, and each incoming call (title "Incoming Call", message the call type).

When the handler returns true, the job sends nothing else; when it returns anything else or fails, the job sends the update as before. One handler at a time: setting one replaces the last.

exports['oxide-animalcontroljob']:SetUpdateHandler(function(source, update)
    -- update.title: the sender, for example "Animal Control - Animal Control Office"
    -- update.message: the message
    -- update.summary: { jobs, net } on the pay summary, sent when a shift ends (on a clock-out only
    -- with Config.shiftSummary = 'text'; never on a disconnect or logout)
    return true -- shown; the job sends nothing else
end)

Parameters: handler (function or nil) — handler(source, update). nil removes the handler your resource set. It is also removed when your resource stops.

Returns: boolean — true, or false when nil would remove another resource's handler (it stays).

Integration Examples

Stop a player from working two jobs at once

Check before your own job lets the player clock in:

RegisterNetEvent('my-job:server:clockIn', function()
    local src = source
    if GetResourceState('oxide-animalcontroljob') == 'started'
        and exports['oxide-animalcontroljob']:IsOnShift(src) then
        -- tell the player to finish their animal control shift first
        return
    end
    -- start your job
end)

Check every gig job at once

The same IsOnShift(source) export exists on oxide-postaljob, oxide-pizzajob, oxide-landscapingjob, oxide-roadsideassistancejob, oxide-animalcontroljob and oxide-newspaperjob. Skip any you don't run:

local GIG_JOBS = {
    'oxide-postaljob',
    'oxide-pizzajob',
    'oxide-landscapingjob',
    'oxide-roadsideassistancejob',
    'oxide-animalcontroljob',
    'oxide-newspaperjob',
}

local function isOnGigShift(src)
    for _, resource in ipairs(GIG_JOBS) do
        if GetResourceState(resource) == 'started' and exports[resource]:IsOnShift(src) then
            return true
        end
    end
    return false
end

Next Steps