Client

Local inventory. These calls do not take a server id. Adding and removing items stays on the server.

ESX default items and chezza have no metadata. When the selected inventory has no matching call, the result is nil or false.

GetItemCount

Parameters

item string
metadata table — optional

Returns

number

Example

local count = Bridge.GetItemCount('water')
 
if count > 0 then
    Bridge.Notify({ description = ('Water x%s'):format(count), kind = 'info' })
end

HasItem

Parameters

item string
count number — optional. Defaults to 1.
metadata table — optional

Returns

boolean

Example

if Bridge.HasItem('lockpick', 1) then
    Bridge.ShowText('You can pick this lock')
end

GetItemLabel

Parameters

item string

Returns

string

Example

print(Bridge.GetItemLabel('water'))

GetSlotWithItem

Parameters

item string
metadata table — optional

Returns

table|nil — { name, count, metadata, slot }.

Example

local slot = Bridge.GetSlotWithItem('phone')
 
if slot then
    Bridge.UseSlot(slot.slot)
end

GetPlayerItems

Parameters

None.

Returns

table — list of { name, count, metadata, slot, label }.

Example

local items = Bridge.GetPlayerItems()
 
for i = 1, #items do
    print(items[i].name, items[i].count)
end

GetCurrentWeapon

Parameters

None.

Returns

table|nil — one item row, or nil when nothing is equipped.

Example

local weapon = Bridge.GetCurrentWeapon()
 
if weapon then
    print(weapon.name, weapon.slot)
end

GetPlayerWeight

Parameters

None.

Returns

number

Example

print(Bridge.GetPlayerWeight(), Bridge.GetPlayerMaxWeight())

GetPlayerMaxWeight

Parameters

None.

Returns

number

Example

local maxWeight = Bridge.GetPlayerMaxWeight()

OpenInventory

Kinds are player, shop, stash, crafting, container, drop, glovebox, trunk, and dumpster. ESX and chezza return false. Opening another player returns false on jaksam.

Parameters

kind string
data table|string|number — stash { id, owner }, shop { type, id }, trunk { netid }, or a target server id

Returns

boolean

Example

Bridge.OpenInventory('stash', { id = 'police_locker', owner = 'license:xxxxxxxx' })
Bridge.OpenInventory('player', target)
Bridge.OpenInventory('trunk', { netid = NetworkGetNetworkIdFromEntity(vehicle) })

CloseInventory

Parameters

None.

Returns

boolean

Example

Bridge.CloseInventory()

SetStashTarget

The next stash open uses this id until you clear it.

Parameters

id string|nil
owner string|nil — optional

Returns

boolean

Example

Bridge.SetStashTarget('motel5', 'bobsmith')
Bridge.OpenInventory('stash')

UseSlot

Parameters

slot number

Returns

boolean

Example

local phone = Bridge.GetSlotWithItem('phone')
 
if phone then
    Bridge.UseSlot(phone.slot)
end

GiveItemToTarget

Parameters

serverId number — the other player
slot number
count number

Returns

boolean

Example

local slot = Bridge.GetSlotWithItem('water')
 
if slot then
    Bridge.GiveItemToTarget(serverId, slot.slot, 1)
end

DisplayMetadata

Adds a label for a metadata key in the tooltip.

Parameters

metadata table|string — { serial = 'Serial' }, or one key
value string — label when metadata is a single key

Returns

boolean

Example

Bridge.DisplayMetadata({ serial = 'Serial', ammo = 'Ammo' })

Server Server