Server Exports

Dispatch

createDispatch(title, message, coords, jobs, meta)

• Purpose: Creates a dispatch entry and broadcasts it to all on-duty members of the target jobs.
• Arguments:
  • title (string) — dispatch title. Required.
  • message (string) — dispatch description.
  • coords (vector3 | table) — location {x, y, z}. Required.
  • jobs (string | string[]) — job name or array of job names.
  • meta (table?) — optional metadata:
    • source (number?) — source player ID.
    • sourceId (string?) — additional source identifier.
    • category (string?) — dispatch category.
• Returns: table | nil — the dispatch entry on success, nil on validation failure.

local dispatch = exports["sky_jobs_base"]:createDispatch(
    "Bank Robbery",
    "Silent alarm triggered at Pacific Standard",
    vector3(235.0, 216.0, 106.0),
    { "police" },
    { category = "robbery", source = source }
)

if dispatch then
    print("Dispatch created:", dispatch.id)
end

Dispatch Entry Structure

HasDispatch(sourceKey, sourceId)

• Purpose: Checks if an active dispatch exists for the given source.
• Arguments:
  • sourceKey (string) — source identifier key.
  • sourceId (string) — source ID value.
• Returns: boolean — true if a non-done dispatch exists.

local exists = exports["sky_jobs_base"]:HasDispatch("player", "license:abc123")

if exists then
    print("Active dispatch already exists")
end

Gallery

takeServerImage(rawDataUrl, cameraMetadata)

• Purpose: Uploads a base64 image to the configured image provider.
• Arguments:
  • rawDataUrl (string) — base64-encoded image data URL.
  • cameraMetadata (table) — metadata about the camera/capture context.
• Returns:
  • boolean — true on success, false on failure.
  • table | string — on success: { data = { url, id, image_id } }. On failure: error message.

local ok, result = exports["sky_jobs_base"]:takeServerImage(imageData, {
    type = "bodycam",
    timestamp = os.time()
})

if ok then
    print("Uploaded:", result.data.url)
end

Creator

openCreatorByJob(source, jobKey)

• Purpose: Opens the registered station creator for a player by job key after validating the creator permission.
• Arguments:
  • source (number) - server ID of the player who should receive the creator UI.
  • jobKey (string) - registered job key.
• Returns:
  • boolean - true on success.
  • string? - failure reason such as "creator_not_found" or "no_permission".

local ok, reason = exports["sky_jobs_base"]:openCreatorByJob(source, "mechanic")

openCreatorByJobWithoutPermission(source, jobKey)

• Purpose: Opens the registered station creator for a player by job key without running the creator permission check. Use only from trusted server-side integrations that already authorized the player.
• Arguments:
  • source (number) - server ID of the player who should receive the creator UI.
  • jobKey (string) - registered job key.
• Returns:
  • boolean - true on success.
  • string? - failure reason such as "creator_not_found" or "invalid_source".

local ok, reason = exports["sky_jobs_base"]:openCreatorByJobWithoutPermission(source, "mechanic")

Storage

AddStorageItem(stationId, jobName, grade, name, amount, metadata)

• Purpose: Adds one item stack directly to a station storage. The export validates basic input and storage capacity before inserting.
• Arguments:
  • stationId (string | number) - target station ID.
  • jobName (string) - job name used for storage restrictions.
  • grade (number?) - job grade context.
  • name (string) - item name.
  • amount (number) - positive item count.
  • metadata (table?) - optional item metadata.
• Returns: boolean - true when the item was added.

local ok = exports["sky_jobs_base"]:AddStorageItem(
    "station_1",
    "mechanic",
    2,
    "repair_crate",
    1,
    { quality = 100 }
)

AddStorageItems(stationId, jobName, grade, items)

• Purpose: Adds multiple item stacks directly to a station storage in one call. The export validates all items and checks total capacity before inserting.
• Arguments:
  • stationId (string | number) - target station ID.
  • jobName (string) - job name used for storage restrictions.
  • grade (number?) - job grade context.
  • items (table[]) - array of items with name, amount or quantity, and optional metadata.
• Returns: boolean - true when all valid items were added.

local ok = exports["sky_jobs_base"]:AddStorageItems("station_1", "mechanic", 2, {
    { name = "repair_crate", amount = 1, metadata = { quality = 100 } },
    { name = "cleaning_kit", quantity = 2 }
})

External Garage Integration

These exports allow third-party garage systems to register and unregister vehicles so the trunk inventory and prop system works for externally-spawned job vehicles.

registerExternalVehicle(plate, jobName, model, netId, ownerSource, trunkCapacity)

• Purpose: Registers an externally-spawned vehicle in the sky_jobs_base vehicle tracking system. This enables trunk inventory, prop placement, and all trunk-related server callbacks for the vehicle.
• Arguments:
  • plate (string) — the vehicle license plate. Required.
  • jobName (string) — the job this vehicle belongs to (e.g. "ambulance", "police"). Required.
  • model (string?) — vehicle model name (e.g. "ambulance"). Defaults to "unknown".
  • netId (number?) — network ID of the spawned vehicle entity.
  • ownerSource (number?) — server ID of the player who spawned the vehicle.
  • trunkCapacity (number?) — trunk weight capacity. Defaults to 50.
• Returns: boolean — true on success, false if plate or jobName is missing.

-- After spawning the vehicle on the server:
local plate = GetVehicleNumberPlateText(vehicle)
local netId = NetworkGetNetworkIdFromEntity(vehicle)

exports["sky_jobs_base"]:registerExternalVehicle(
    plate,
    "ambulance",
    "ambulance",
    netId,
    source,
    80
)

unregisterExternalVehicle(plate)

• Purpose: Removes an externally-registered vehicle from the tracking system. Call this when the vehicle is despawned or parked by the external garage.
• Arguments:
  • plate (string) — the vehicle license plate. Required.
• Returns: boolean — true on success, false if plate is invalid.

exports["sky_jobs_base"]:unregisterExternalVehicle(plate)

Full Usage Example

-- When spawning the vehicle
RegisterNetEvent("mygarage:vehicleSpawned", function(plate, model, netId)
    exports["sky_jobs_base"]:registerExternalVehicle(
        plate, "ambulance", model, netId, source, 80
    )
end)

-- When despawning / parking the vehicle
RegisterNetEvent("mygarage:vehicleDespawned", function(plate)
    exports["sky_jobs_base"]:unregisterExternalVehicle(plate)
end)

-- After the vehicle entity exists on the client
local vehicle = NetToVeh(netId)

exports["sky_jobs_base"]:registerExternalTrunkVehicle(vehicle)

-- When despawning
exports["sky_jobs_base"]:unregisterExternalTrunkVehicle(vehicle)

Salary

These exports allow external resources (e.g. AFK scripts) to temporarily pause and resume salary payouts for a player, preventing paycheck farming.

pausePlayerSalary(playerId)

• Purpose: Pauses salary payouts for the given player. While paused, the player will not receive any automatic salary payments.
• Arguments:
  • playerId (number) — the server ID of the player. Required.
• Returns: boolean — true on success, false if the player ID is invalid.

exports["sky_jobs_base"]:pausePlayerSalary(playerId)

resumePlayerSalary(playerId)

• Purpose: Resumes salary payouts for the given player after they were paused.
• Arguments:
  • playerId (number) — the server ID of the player. Required.
• Returns: boolean — true on success, false if the player ID is invalid.

exports["sky_jobs_base"]:resumePlayerSalary(playerId)

isPlayerSalaryPaused(playerId)

• Purpose: Checks whether salary payouts are currently paused for the given player.
• Arguments:
  • playerId (number) — the server ID of the player.
• Returns: boolean — true if paused, false otherwise.

local paused = exports["sky_jobs_base"]:isPlayerSalaryPaused(playerId)

Usage Example

-- When a player goes AFK
AddEventHandler("sky_afk:playerAFK", function(playerId)
    exports["sky_jobs_base"]:pausePlayerSalary(playerId)
end)

-- When a player returns from AFK
AddEventHandler("sky_afk:playerReturned", function(playerId)
    exports["sky_jobs_base"]:resumePlayerSalary(playerId)
end)

Support

Need help? Our support team is always ready to assist