Server

This section completes the API reference by covering Inventory, Server-Side Vehicle Keys, and Third-Party Banking integrations. These functions are located in integration/server/ and exposed via the main Bridge object.

Inventory

The bridge provides a unified API for managing player inventories.

Bridge.AddItem

Adds an item to the player's inventory. Handles slot and metadata for supported inventories.

--- @param source number Player Server ID
--- @param item string Item name
--- @param amount number Count
--- @param slot number|nil (Optional) Specific slot
--- @param meta table|nil (Optional) Item metadata
--- @return boolean Success
local success = Bridge.AddItem(source, 'water', 5, nil, { quality = 100 })

Bridge.RemoveItem

Removes an item from the player's inventory.

--- @param source number Player Server ID
--- @param item string Item name
--- @param amount number Count
--- @return boolean Success
local success = Bridge.RemoveItem(source, 'water', 1)

Bridge.GetInventoryItem

Gets the count of a specific item in the player's inventory.

--- @param source number Player Server ID
--- @param item string Item name
--- @return number Count
local count = Bridge.GetInventoryItem(source, 'plastic')

Bridge.HasEnoughItem

Checks if the player has at least the specified amount of an item.

--- @param source number
--- @param item string
--- @param amount number
--- @return boolean
if Bridge.HasEnoughItem(source, 'money', 500) then
    print("Player can pay!")
end

Bridge.CanCarryItem

Checks if the player has enough weight/space to carry the item (Crucial for Ox/QB/QS).

--- @param source number
--- @param item string
--- @param amount number
--- @return boolean
if Bridge.CanCarryItem(source, 'stone', 10) then
    Bridge.AddItem(source, 'stone', 10)
else
    Bridge.Notify(source, "Inventory full!", "error")
end

Bridge.GetItems

Returns the server's master list of items (definitions).

--- @return table Key-value pair of items
local items = Bridge.GetItems()
print(items['water'].label)

Bridge.GetItemLabel

Returns the label of a specific item.

--- @param item string Item name
--- @return string Label
local label = Bridge.GetItemLabel('sandwich') -- Returns "Sandwich"

Bridge.CreateUseableItem

Registers a usable item callback.

--- @param item string Item name
--- @param cb function Callback function(source, item)
Bridge.CreateUseableItem('bandage', function(source, item)
    Bridge.RemoveItem(source, 'bandage', 1)
    Bridge.Notify(source, "Used Bandage", "success")
end)

---

Vehicle Keys (Server)

These functions allow you to give or remove vehicle keys directly from the server side.

Bridge.GiveVehicleKey

Gives keys for a specific vehicle to a player.

--- @param source number Player Server ID
--- @param plate string Vehicle Plate
--- @param vehNetId number Network ID of the vehicle entity
--- @param virtual boolean (Optional) Give temporary/virtual keys
Bridge.GiveVehicleKey(source, "ABC 123", vehNetId, false)

Bridge.RemoveVehicleKey

Removes keys for a specific vehicle from a player.

--- @param source number Player Server ID
--- @param plate string Vehicle Plate
--- @param vehNetId number Network ID of the vehicle entity
--- @param virtual boolean (Optional) Remove temporary/virtual keys
Bridge.RemoveVehicleKey(source, "ABC 123", vehNetId, false)

---

Banking Integration

it is important to note that the Integration layer (integration/server/banking.lua) extends these functions to support third-party banking resources automatically.

Bridge.GetSocietyMoney

Retrieves the current available balance of a specific job or society account.

--- @param job string
local balance = Bridge.GetSocietyMoney('police')
print(balance)

Bridge.AddSocietyMoney

Deposits funds into a specific job or society account.

--- @param job string
--- @param amount number
Bridge.AddSocietyMoney('police', 5000)

Bridge.RemoveSocietyMoney

Withdraws or removes funds from a specific job or society account.

--- @param job string
--- @param amount number
Bridge.RemoveSocietyMoney('police', 200)