Class CS2Inventory

constructor

• new CS2Inventory(__namedParameters?: Partial<CS2InventorySpec>): CS2Inventory

  Parameters

  • __namedParameters: Partial<CS2InventorySpec> = {}

  Returns CS2Inventory

Readonlyoptions

add

• add(item: CS2BaseInventoryItem): this

  Parameters

  • item: CS2BaseInventoryItem

  Returns this

addWithNameTag

• addWithNameTag(nameTagUid: number, id: number, nameTag: string): this

  Parameters

  • nameTagUid: number
  • id: number
  • nameTag: string

  Returns this

addWithSticker

• addWithSticker(
      stickerUid: number,
      id: number,
      attributes?: Omit<RecordValue<CS2BaseInventoryItem["stickers"]>, "id">,
  ): this

  Adds a new item id to the inventory with the sticker item stickerUid applied to its first slot, consuming the sticker. The optional attributes set that sticker's schema (its physical CS2EconomyItem.getStickerSchemaCount anchor), x/y offset, rotation, and wear. All are validated against the new item before anything mutates, so an invalid value throws without consuming the sticker.

  Parameters

  • stickerUid: number
  • id: number
  • attributes: Omit<RecordValue<CS2BaseInventoryItem["stickers"]>, "id"> = {}

  Returns this

applyItemPatch

• applyItemPatch(targetUid: number, patchUid: number, slot: number): this

  Parameters

  • targetUid: number
  • patchUid: number
  • slot: number

  Returns this

applyItemSticker

• applyItemSticker(
      targetUid: number,
      stickerUid: number,
      attributes?: Omit<RecordValue<CS2BaseInventoryItem["stickers"]>, "id">,
  ): this

  Applies the sticker item stickerUid onto targetUid, appending it to the stack. The optional attributes set the new sticker's schema (its physical CS2EconomyItem.getStickerSchemaCount anchor — defaults to the next free anchor), x/y offset, rotation, and wear. All are validated against the target before anything mutates, so an invalid value throws without consuming the sticker.

  Parameters

  • targetUid: number
  • stickerUid: number
  • attributes: Omit<RecordValue<CS2BaseInventoryItem["stickers"]>, "id"> = {}

  Returns this

canDepositToStorageUnit

• canDepositToStorageUnit(storageUid: number, size?: number): boolean

  Parameters

  • storageUid: number
  • size: number = 1

  Returns boolean

canRetrieveFromStorageUnit

• canRetrieveFromStorageUnit(storageUid: number, size?: number): boolean

  Parameters

  • storageUid: number
  • size: number = 1

  Returns boolean

depositToStorageUnit

• depositToStorageUnit(storageUid: number, depositUids: number[]): this

  Parameters

  • storageUid: number
  • depositUids: number[]

  Returns this

edit

• edit(itemUid: number, properties: Partial<CS2BaseInventoryItem>): this

  Parameters

  • itemUid: number
  • properties: Partial<CS2BaseInventoryItem>

  Returns this

editItemSticker

• editItemSticker(
      targetUid: number,
      index: number,
      patch: Partial<RecordValue<CS2BaseInventoryItem["stickers"]>>,
  ): this

  Parameters

  • targetUid: number
  • index: number
  • patch: Partial<RecordValue<CS2BaseInventoryItem["stickers"]>>

  Returns this

equip

• equip(itemUid: number, team?: CS2Team): this

  Parameters

  • itemUid: number
  • Optionalteam: CS2Team

  Returns this

get

• get(uid: number): CS2InventoryItem

  Parameters

  • uid: number

  Returns CS2InventoryItem

getAll

• getAll(): CS2InventoryItem[]

  Returns CS2InventoryItem[]

getAllAsBase

• getAllAsBase(): CS2BaseInventoryItem[]

  Returns CS2BaseInventoryItem[]

getData

• getData(): CS2InventoryData

  Returns CS2InventoryData

getStorageUnitItems

• getStorageUnitItems(storageUid: number): CS2InventoryItem[]

  Parameters

  • storageUid: number

  Returns CS2InventoryItem[]

getStorageUnitSize

• getStorageUnitSize(storageUid: number): number

  Parameters

  • storageUid: number

  Returns number

healBaseInventoryItem

• healBaseInventoryItem(item: CS2BaseInventoryItem): void

  Parameters

  • item: CS2BaseInventoryItem

  Returns void

incrementItemStatTrak

• incrementItemStatTrak(targetUid: number): this

  Parameters

  • targetUid: number

  Returns this

isFull

• isFull(): boolean

  Returns boolean

isStorageUnitFilled

• isStorageUnitFilled(storageUid: number): boolean

  Parameters

  • storageUid: number

  Returns boolean

isStorageUnitFull

• isStorageUnitFull(storageUid: number): boolean

  Parameters

  • storageUid: number

  Returns boolean

move

• move(options?: Partial<CS2InventorySpec>): CS2Inventory

  Parameters

  • options: Partial<CS2InventorySpec> = {}

  Returns CS2Inventory

moveItemSticker

• moveItemSticker(targetUid: number, fromIndex: number, toIndex: number): this

  Parameters

  • targetUid: number
  • fromIndex: number
  • toIndex: number

  Returns this

remove

• remove(uid: number): this

  Parameters

  • uid: number

  Returns this

removeAll

• removeAll(): this

  Returns this

removeInvalidItemReferences

• removeInvalidItemReferences(item: CS2BaseInventoryItem): void

  Parameters

  • item: CS2BaseInventoryItem

  Returns void

  Deprecated

  Use healBaseInventoryItem instead.

removeItemPatch

• removeItemPatch(targetUid: number, slot: number): this

  Parameters

  • targetUid: number
  • slot: number

  Returns this

removeItemSticker

• removeItemSticker(targetUid: number, index: number): this

  Parameters

  • targetUid: number
  • index: number

  Returns this

renameItem

• renameItem(nameTagUid: number, renameableUid: number, nameTag?: string): this

  Parameters

  • nameTagUid: number
  • renameableUid: number
  • OptionalnameTag: string

  Returns this

renameStorageUnit

• renameStorageUnit(storageUid: number, nameTag: string): this

  Parameters

  • storageUid: number
  • nameTag: string

  Returns this

retrieveFromStorageUnit

• retrieveFromStorageUnit(storageUid: number, retrieveUids: number[]): this

  Parameters

  • storageUid: number
  • retrieveUids: number[]

  Returns this

scrapeItemSticker

• scrapeItemSticker(targetUid: number, index: number, wear?: number): this

  Parameters

  • targetUid: number
  • index: number
  • Optionalwear: number

  Returns this

setAll

• setAll(items: Map<number, CS2InventoryItem>): this

  Parameters

  • items: Map<number, CS2InventoryItem>

  Returns this

size

• size(): number

  Returns number

stringify

• stringify(): string

  Returns string

swapItemsStatTrak

• swapItemsStatTrak(
      statTrakSwapToolUid: number,
      fromUid: number,
      toUid: number,
  ): this

  Parameters

  • statTrakSwapToolUid: number
  • fromUid: number
  • toUid: number

  Returns this

unequip

• unequip(uid: number, team?: CS2Team): this

  Parameters

  • uid: number
  • Optionalteam: CS2Team

  Returns this

unlockContainer

• unlockContainer(
      unlockedItem: CS2UnlockedItem,
      containerUid: number,
      keyUid?: number,
  ): this

  Parameters

  • unlockedItem: CS2UnlockedItem
  • containerUid: number
  • OptionalkeyUid: number

  Returns this

validateBaseInventoryItem

• validateBaseInventoryItem(__namedParameters: CS2BaseInventoryItem): void

  Parameters

  • __namedParameters: CS2BaseInventoryItem

  Returns void

Staticparse

• parse(
      stringValue: string | null | undefined,
      economy?: CS2EconomyInstance,
  ): CS2InventoryData | undefined

  Parameters

  • stringValue: string | null | undefined
  • Optionaleconomy: CS2EconomyInstance

  Returns CS2InventoryData | undefined