Bridge
Inventory
Client

Inventory Client

Items

Framework.Items

returns: Item[]

OpenStash

Opens stash registered using RegisterStash

Framework.OpenStash(name)
  • name: string
Framework.OpenStash('mystash')

OpenShop

Open named shop registered using RegisterShop

Framework.OpenShop(name)
  • name: string
Framework.OpenShop('myshop')

GetItem

Get Item From Player Inventory

Framework.GetItem(item, metadata, strict)
  • item: string
  • metadata?: table
  • strict?: boolean
    • Strictly match metadata or partial matching

returns: Item[]

Framework.GetItem('water_bottle')

HasItem

Check if a player has an item or items

Framework.HasItem(items, count, metadata, strict)
  • items: string | string[] | table<string, number>
  • count?: number
  • metadata?: table
  • strict?: boolean
    • Strictly match metadata or partial matching

returns: boolean

Checking a single item

Framework.HasItem('water_bottle', 1)

Checking a single item with metadata

Framework.HasItem('water_bottle', 1, { quality = 100 })

Checking multiple items

Framework.HasItem({'water_bottle', 'burger' }, 1)

Checking multiple items with different quantity

Framework.HasItem({['water_bottle'] = 1, ['burger'] = 2})

LockInventory

Locks Inventory

Framework.LockInventory()

UnlockInventory

Unlocks Inventory

Framework.UnlockInventory()