Client Exports

Radial Menu

getRadialActions()

• Purpose: Provides the current list of radial menu actions along with labels, descriptions, and availability metadata.
• Returns: RadialAction[] where each entry contains id, label, description, icon, available, and optional badge or helper fields.

local actions = exports["sky_ambulancejob"]:getRadialActions()

getRadialAction(actionId)

• Purpose: Fetches a single action snapshot by actionId.
• Arguments:
  • actionId (string)
• Returns: The action snapshot or nil when missing.

local action = exports["sky_ambulancejob"]:getRadialAction("treat_patient")

getRadialActionReport()

• Purpose: Bundles the action list with a quick lookup map for availability and reason information.
• Returns: Object with actions and availability, where each key maps to available, disabledReasonKey, and disabledReason.

local report = exports["sky_ambulancejob"]:getRadialActionReport()

isRadialMenuActionAvailable(actionId)

• Purpose: Tests if a radial menu action is currently enabled without opening the menu.
• Arguments:
  • actionId (string)
• Returns: boolean (true when the action exists and is enabled).

local available = exports["sky_ambulancejob"]:isRadialMenuActionAvailable("treat_patient")

triggerRadialMenuAction(actionId)

• Purpose: Executes the same handler the radial menu would for the given action, without opening the UI.
• Arguments:
  • actionId (string)
• Returns:
  • boolean: true when the action was accepted.
  • table?: When the action fails, returns a map with key/fallback for notification text.

local success, err = exports["sky_ambulancejob"]:triggerRadialMenuAction("treat_patient")

Radial Menu Actions

Each action mirrors the descriptions and availability logic of the in-game radial UI.

Crutch

EquipCrutch()

• Purpose: Equips a crutch on the local player.

exports["sky_ambulancejob"]:EquipCrutch()

UnequipCrutch()

• Purpose: Removes the crutch from the local player.

exports["sky_ambulancejob"]:UnequipCrutch()

ToggleCrutch()

• Purpose: Toggles the crutch on or off.

exports["sky_ambulancejob"]:ToggleCrutch()

SetWalkStyle(style)

• Purpose: Sets the crutch walk animation style.
• Arguments:
  • style (string): The clipset name for the walk animation.

exports["sky_ambulancejob"]:SetWalkStyle("move_m@injured")

Wheelchair

EquipWheelchair()

• Purpose: Equips a wheelchair for the local player.

exports["sky_ambulancejob"]:EquipWheelchair()

UnequipWheelchair()

• Purpose: Removes the wheelchair from the local player.

exports["sky_ambulancejob"]:UnequipWheelchair()

ToggleWheelchair()

• Purpose: Toggles the wheelchair on or off.

exports["sky_ambulancejob"]:ToggleWheelchair()

Revive

revive(payload?)

• Purpose: Revives the local player by sending a server-validated revive request. Only works when the player is currently dead.
• Arguments:
  • payload (table?): Optional revive context.
    • reason (string?): Controls post-revive behaviour.
      • "command" — Admin/force revive. Skips the death timeout (combat lockout).
      • nil / omitted — Normal revive. Death timeout applies as configured.

-- Normal revive
exports["sky_ambulancejob"]:revive()

-- Admin revive (skips death timeout)
exports["sky_ambulancejob"]:revive({ reason = "command" })

Death Screen

open()

• Purpose: Opens the death screen UI.

exports["sky_ambulancejob"]:open()

updateTime(seconds)

• Purpose: Updates the bleed-out timer to a specific value.
• Arguments:
  • seconds (number): The new timer value in seconds.

exports["sky_ambulancejob"]:updateTime(120)

addTime(seconds)

• Purpose: Adds time to the current bleed-out timer.
• Arguments:
  • seconds (number): Seconds to add.

exports["sky_ambulancejob"]:addTime(30)

AI Medic

setAiMedicState(state, reason?)

• Purpose: Updates the AI medic status shown on the death screen UI. Use this when you override the built-in AI medic via Config.Functions.onAiMedicRequest and need to update the UI from your own system.
• Arguments:
  • state (string): One of "idle", "requesting", "dispatched", "driving", "arrived", "reviving", "finished", "failed", "cooldown".
  • reason (string?): Optional failure reason when state is "failed" — "not_enough_money", "medics_online", "spawn_failed", "disabled".

-- Show "AI medic on the way"
exports["sky_ambulancejob"]:setAiMedicState("driving")

-- Show failure
exports["sky_ambulancejob"]:setAiMedicState("failed", "spawn_failed")

-- Reset to idle
exports["sky_ambulancejob"]:setAiMedicState("idle")

getAiMedicState()

• Purpose: Returns the current AI medic state.
• Returns: string — the current state (e.g. "idle", "driving", "reviving").

local state = exports["sky_ambulancejob"]:getAiMedicState()

isAiMedicActive()

• Purpose: Checks if the AI medic is currently active or pending.
• Returns: boolean

local active = exports["sky_ambulancejob"]:isAiMedicActive()

-- config/functions.lua
Config.Functions.onAiMedicRequest = function()
    exports['my-medic-resource']:sendHelp()
    return false -- prevent built-in AI medic
end

Death Timeout

stopDeathTimeout()

• Purpose: Immediately stops the active death timeout (combat lockout) for the local player.

exports["sky_ambulancejob"]:stopDeathTimeout()

setDeathTimeout(seconds)

• Purpose: Sets or overrides the death timeout duration. Pass 0 to stop the current timeout.
• Arguments:
  • seconds (number): Duration in seconds.

exports["sky_ambulancejob"]:setDeathTimeout(120)

getDeathTimeout()

• Purpose: Returns the current death timeout state.
• Returns: table with active (boolean) and remaining (number, seconds).

local state = exports["sky_ambulancejob"]:getDeathTimeout()
if state.active then
    print("Timeout remaining: " .. state.remaining .. "s")
end

Injury & State

GetLocalInjuryProfile()

• Purpose: Returns the current player's injury profile with all active conditions and wounds.
• Returns: table — the full injury profile object.

local profile = exports["sky_ambulancejob"]:GetLocalInjuryProfile()

isDead()

• Purpose: Queries the local player's death state.
• Returns: boolean (true when dead/downed, false when alive).

local dead = exports["sky_ambulancejob"]:isDead()

Self-Diagnose

OpenSelfDiagnose()

• Purpose: Opens the full diagnose UI on the local player, allowing them to inspect and treat their own injuries. Requires Config.SelfDiagnose.enabled = true. When Config.SelfDiagnose.requireMedicJob is true (default), only on-duty medics can use this export.
• Returns:
  • boolean: true when the diagnose UI was opened successfully.
  • string?: Reason when the call fails — "disabled", "no_permission", "busy", "dead".

local success, reason = exports["sky_ambulancejob"]:OpenSelfDiagnose()
if not success then
    print("Self-diagnose failed: " .. (reason or "unknown"))
end

Insurance

OpenInsurance()

• Purpose: Opens the insurance UI for the local player.

exports["sky_ambulancejob"]:OpenInsurance()

Stretcher

openStretcherEditor(payload)

• Purpose: Opens the interactive stretcher positioning editor for vehicle attachment configuration. Spawns a preview vehicle with an attached stretcher that can be repositioned via keyboard controls.
• Arguments:
  • payload (table):
    • model (string | number) — Vehicle model name or hash. Required.
    • name (string?) — Optional display name for the vehicle.
• Returns: table with:
  • success (boolean) — true when the editor opened successfully.
  • error (string?) — Error message when success is false.

local result = exports["sky_ambulancejob"]:openStretcherEditor({
    model = "ambulance",
    name  = "Ambulance"
})

if not result.success then
    print("Error: " .. result.error)
end

Support

Need help? Our support team is always ready to assist