@ianlucas/cs2-lib
Preparing search index...
CS2Inventory
Class CS2Inventory
Index
Constructors
constructor
Properties
options
Methods
add
add
With
Nametag
add
With
Sticker
apply
Item
Patch
apply
Item
Sticker
can
Deposit
To
Storage
Unit
can
Retrieve
From
Storage
Unit
deposit
To
Storage
Unit
edit
equip
get
get
All
get
All
As
Base
get
Data
get
Storage
Unit
Items
get
Storage
Unit
Size
increment
Item
Stat
Trak
is
Full
is
Storage
Unit
Filled
is
Storage
Unit
Full
move
remove
remove
All
remove
Invalid
Item
References
remove
Item
Patch
rename
Item
rename
Storage
Unit
retrieve
From
Storage
Unit
scrape
Item
Sticker
set
All
size
stringify
swap
Items
Stat
Trak
unequip
unlock
Container
validate
Base
Inventory
Item
parse
Constructors
constructor
new
CS2Inventory
(
__namedParameters
?:
Partial
<
CS2InventorySpec
>
)
:
CS2Inventory
Parameters
__namedParameters
:
Partial
<
CS2InventorySpec
>
= {}
Returns
CS2Inventory
Properties
Readonly
options
options
:
Readonly
<
CS2InventoryOptions
>
Methods
add
add
(
item
:
CS2BaseInventoryItem
)
:
this
Parameters
item
:
CS2BaseInventoryItem
Returns
this
add
With
Nametag
addWithNametag
(
nameTagUid
:
number
,
id
:
number
,
nameTag
:
string
)
:
this
Parameters
nameTagUid
:
number
id
:
number
nameTag
:
string
Returns
this
add
With
Sticker
addWithSticker
(
stickerUid
:
number
,
id
:
number
,
slot
:
number
)
:
this
Parameters
stickerUid
:
number
id
:
number
slot
:
number
Returns
this
apply
Item
Patch
applyItemPatch
(
targetUid
:
number
,
patchUid
:
number
,
slot
:
number
)
:
this
Parameters
targetUid
:
number
patchUid
:
number
slot
:
number
Returns
this
apply
Item
Sticker
applyItemSticker
(
targetUid
:
number
,
stickerUid
:
number
,
slot
:
number
)
:
this
Parameters
targetUid
:
number
stickerUid
:
number
slot
:
number
Returns
this
can
Deposit
To
Storage
Unit
canDepositToStorageUnit
(
storageUid
:
number
,
size
?:
number
)
:
boolean
Parameters
storageUid
:
number
size
:
number
= 1
Returns
boolean
can
Retrieve
From
Storage
Unit
canRetrieveFromStorageUnit
(
storageUid
:
number
,
size
?:
number
)
:
boolean
Parameters
storageUid
:
number
size
:
number
= 1
Returns
boolean
deposit
To
Storage
Unit
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
equip
equip
(
itemUid
:
number
,
team
?:
CS2TeamValues
)
:
this
Parameters
itemUid
:
number
Optional
team
:
CS2TeamValues
Returns
this
get
get
(
uid
:
number
)
:
CS2InventoryItem
Parameters
uid
:
number
Returns
CS2InventoryItem
get
All
getAll
()
:
CS2InventoryItem
[]
Returns
CS2InventoryItem
[]
get
All
As
Base
getAllAsBase
()
:
CS2BaseInventoryItem
[]
Returns
CS2BaseInventoryItem
[]
get
Data
getData
()
:
CS2InventoryData
Returns
CS2InventoryData
get
Storage
Unit
Items
getStorageUnitItems
(
storageUid
:
number
)
:
CS2InventoryItem
[]
Parameters
storageUid
:
number
Returns
CS2InventoryItem
[]
get
Storage
Unit
Size
getStorageUnitSize
(
storageUid
:
number
)
:
number
Parameters
storageUid
:
number
Returns
number
increment
Item
Stat
Trak
incrementItemStatTrak
(
targetUid
:
number
)
:
this
Parameters
targetUid
:
number
Returns
this
is
Full
isFull
()
:
boolean
Returns
boolean
is
Storage
Unit
Filled
isStorageUnitFilled
(
storageUid
:
number
)
:
boolean
Parameters
storageUid
:
number
Returns
boolean
is
Storage
Unit
Full
isStorageUnitFull
(
storageUid
:
number
)
:
boolean
Parameters
storageUid
:
number
Returns
boolean
move
move
(
options
?:
Partial
<
CS2InventorySpec
>
)
:
CS2Inventory
Parameters
options
:
Partial
<
CS2InventorySpec
>
= {}
Returns
CS2Inventory
remove
remove
(
uid
:
number
)
:
this
Parameters
uid
:
number
Returns
this
remove
All
removeAll
()
:
this
Returns
this
remove
Invalid
Item
References
removeInvalidItemReferences
(
item
:
CS2BaseInventoryItem
)
:
void
Parameters
item
:
CS2BaseInventoryItem
Returns
void
remove
Item
Patch
removeItemPatch
(
targetUid
:
number
,
slot
:
number
)
:
this
Parameters
targetUid
:
number
slot
:
number
Returns
this
rename
Item
renameItem
(
nameTagUid
:
number
,
renameableUid
:
number
,
nameTag
?:
string
)
:
this
Parameters
nameTagUid
:
number
renameableUid
:
number
Optional
nameTag
:
string
Returns
this
rename
Storage
Unit
renameStorageUnit
(
storageUid
:
number
,
nameTag
:
string
)
:
this
Parameters
storageUid
:
number
nameTag
:
string
Returns
this
retrieve
From
Storage
Unit
retrieveFromStorageUnit
(
storageUid
:
number
,
retrieveUids
:
number
[]
)
:
this
Parameters
storageUid
:
number
retrieveUids
:
number
[]
Returns
this
scrape
Item
Sticker
scrapeItemSticker
(
targetUid
:
number
,
slot
:
number
)
:
this
Parameters
targetUid
:
number
slot
:
number
Returns
this
set
All
setAll
(
items
:
Map
<
number
,
CS2InventoryItem
>
)
:
this
Parameters
items
:
Map
<
number
,
CS2InventoryItem
>
Returns
this
size
size
()
:
number
Returns
number
stringify
stringify
()
:
string
Returns
string
swap
Items
Stat
Trak
swapItemsStatTrak
(
statTrakSwapToolUid
:
number
,
fromUid
:
number
,
toUid
:
number
,
)
:
this
Parameters
statTrakSwapToolUid
:
number
fromUid
:
number
toUid
:
number
Returns
this
unequip
unequip
(
uid
:
number
,
team
?:
CS2TeamValues
)
:
this
Parameters
uid
:
number
Optional
team
:
CS2TeamValues
Returns
this
unlock
Container
unlockContainer
(
unlockedItem
:
CS2UnlockedItem
,
containerUid
:
number
,
keyUid
?:
number
,
)
:
this
Parameters
unlockedItem
:
CS2UnlockedItem
containerUid
:
number
Optional
keyUid
:
number
Returns
this
validate
Base
Inventory
Item
validateBaseInventoryItem
(
__namedParameters
:
CS2BaseInventoryItem
)
:
void
Parameters
__namedParameters
:
CS2BaseInventoryItem
Returns
void
Static
parse
parse
(
stringValue
:
undefined
|
null
|
string
,
economy
?:
CS2EconomyInstance
,
)
:
undefined
|
CS2InventoryData
Parameters
stringValue
:
undefined
|
null
|
string
Optional
economy
:
CS2EconomyInstance
Returns
undefined
|
CS2InventoryData
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
options
Methods
add
add
With
Nametag
add
With
Sticker
apply
Item
Patch
apply
Item
Sticker
can
Deposit
To
Storage
Unit
can
Retrieve
From
Storage
Unit
deposit
To
Storage
Unit
edit
equip
get
get
All
get
All
As
Base
get
Data
get
Storage
Unit
Items
get
Storage
Unit
Size
increment
Item
Stat
Trak
is
Full
is
Storage
Unit
Filled
is
Storage
Unit
Full
move
remove
remove
All
remove
Invalid
Item
References
remove
Item
Patch
rename
Item
rename
Storage
Unit
retrieve
From
Storage
Unit
scrape
Item
Sticker
set
All
size
stringify
swap
Items
Stat
Trak
unequip
unlock
Container
validate
Base
Inventory
Item
parse
@ianlucas/cs2-lib
Loading...