Client

This section covers the client-side functions located in integration/client/. These functions unify interactions with third-party resources like Target systems, Inventory (client actions), Fuel, Keys, and UI elements.

Target System

The bridge standardizes all target interactions using the qb-target data structure. If ox_target is used, the bridge automatically converts the syntax (mapping action to onSelect, job to groups, etc.).

Bridge.AddBoxZone

Creates a box zone for targeting.

--- @param name string Unique name for the zone
--- @param center vector3 Central coordinates
--- @param length number Length of the box
--- @param width number Width of the box
--- @param options table Zone options (minZ, maxZ, debugPoly, heading, useZ)
--- @param targetoptions table List of options using qb-target structure
Bridge.AddBoxZone("my_zone", vector3(100.0, 200.0, 30.0), 2.0, 2.0, {
    minZ = 29.0,
    maxZ = 31.0,
    debugPoly = false,
    heading = 90.0
}, {
    options = {
        {
            type = "client", -- or "server", "command"
            event = "myscript:client:action",
            icon = "fas fa-user",
            label = "Interact",
            job = "police", -- qb-target standard
            gang = "ballas", -- qb-target standard
            item = "handcuffs", -- qb-target standard
            action = function() -- Optional function support if not using event
                print("Clicked")
            end
        }
    },
    distance = 2.5
})

Bridge.AddPolyZone

Creates a complex polygon zone.

--- @param name string
--- @param points table List of vector3 points
--- @param options table (minZ, maxZ, debugPoly)
--- @param targetoptions table
Bridge.AddPolyZone("my_poly", {
    vector3(100.0, 100.0, 30.0),
    vector3(105.0, 100.0, 30.0),
    vector3(105.0, 105.0, 30.0)
}, {
    minZ = 29.0,
    maxZ = 31.0
}, { --[[ targetoptions ]] })

Bridge.AddCircleZone

Creates a spherical/circular zone.

--- @param name string
--- @param center vector3
--- @param radius number
--- @param options table
--- @param targetoptions table
Bridge.AddCircleZone("my_circle", vector3(100.0, 200.0, 30.0), 1.5, {
    debugPoly = true
}, { --[[ targetoptions ]] })

Bridge.AddTargetEntity

Adds target options to specific entities (NetID or Local).

--- @param entities table|number Single entity or list of entities
--- @param options table qb-target standard options
Bridge.AddTargetEntity(entity, {
    options = {
        {
            icon = "fas fa-car",
            label = "Check Vehicle",
            action = function(entity)
                print("Checking " .. entity)
            end
        }
    },
    distance = 2.0
})

Bridge.AddTargetModel

Adds target options to specific models.

--- @param models string|number|table Model name/hash or list
--- @param options table
Bridge.AddTargetModel('prop_atm_01', {
    options = {
        {
            event = "bank:open",
            icon = "fas fa-money-bill",
            label = "Use ATM"
        }
    },
    distance = 1.5
})

Bridge.RemoveZone

Removes a registered zone by name.

Bridge.RemoveZone("my_zone")

---

UI & Progress

The bridge standardizes progress bars using the ox_lib data structure.

Bridge.ShowProgress

Displays a progress bar (Circle in Ox, standard bar in QB/ESX).

--- @param data table ox_lib progress structure
--- @param successCb function (optional)
--- @param cancelCb function (optional)
--- @return boolean true if completed, false if cancelled
local success = Bridge.ShowProgress({
    label = 'Repairing Vehicle...',
    duration = 5000,
    position = 'bottom',
    useWhileDead = false,
    canCancel = true,
    disable = {
        move = true,
        car = true,
        combat = true
    },
    anim = {
        dict = 'mini@repair',
        clip = 'fixing_a_ped',
        flag = 49
    },
    prop = {
        model = 'prop_tool_wrench',
        bone = 57005,
        pos = vec3(0.1, 0.0, 0.0),
        rot = vec3(0.0, 0.0, 0.0)
    }
}, function()
    print("Done!")
end, function()
    print("Cancelled!")
end)

Bridge.Notify

Sends a notification to the player.

Lua

--- @param msg string Message content
--- @param type string 'success', 'error', 'info'
--- @param duration number Duration in ms
Bridge.Notify("Vehicle Repaired", "success", 5000)

---

Inventory (Client)

Bridge.OpenStash

Opens a stash inventory for the player.

--- @param identifier string Unique stash ID
--- @param name string Display label
--- @param weight number Max weight (in kg or grams depending on inv)
--- @param slots number Max slots
Bridge.OpenStash("shop_stash_1", "Shop Storage", 100000, 50)

Bridge.OpenSearchInventory

Opens another player's inventory (e.g., searching/robbing).

--- @param targetServerId number
Bridge.OpenSearchInventory(targetServerId)

Bridge.CloseInventory

Forces the inventory to close.

Bridge.CloseInventory()

Bridge.SetInventoryBusy

Sets the player's inventory state to busy (prevents opening).

--- @param state boolean
Bridge.SetInventoryBusy(true)

---

Vehicles & Keys

Bridge.GiveVehicleKey

Gives keys for a specific vehicle to the player.

--- @param plate string
--- @param vehicle entity
--- @param virtual boolean (optional) For temporary keys if supported
Bridge.GiveVehicleKey("ABC 123", vehicleEntity)

Bridge.RemoveVehicleKey

Removes keys from the player.

--- @param plate string
--- @param vehicle entity
Bridge.RemoveVehicleKey("ABC 123", vehicleEntity)

Bridge.SetVehicleFuel

Sets the fuel level of a vehicle.

--- @param vehicle entity
--- @param amount number (0-100)
Bridge.SetVehicleFuel(vehicleEntity, 100.0)

Bridge.StoreVehicleHousing

Stores a vehicle in a housing garage (Supporting CD, OkOk, JG, Loaf, Ak47).

--- @param garageId string
--- @param vehicle entity
Bridge.StoreVehicleHousing("my_house_1", vehicleEntity)

Bridge.OpenGarageHousing

Opens the garage menu for a specific housing property.

--- @param garageId string
Bridge.OpenGarageHousing("my_house_1")

---

Status

Bridge.IsDead

Checks if a player (or self) is dead. Supports Metadata checks and Animation checks.

--- @param target number|nil Target Server ID or nil for self
--- @return boolean
local dead = Bridge.IsDead() -- checks self

Bridge.IsLastStand

Checks if a player is in the "last stand" / downed state.

--- @param target number|nil
--- @return boolean
local downed = Bridge.IsLastStand()

Bridge.IsIncapacitated

Checks if the player is either dead OR in last stand.

--- @param target number|nil
--- @return boolean
if Bridge.IsIncapacitated() then
    print("Player is down or dead")
end