Beta Documentation - Subject to change.

Provides access to a player's backpack.

Methods

  NameDescription
GetItemGets and item from the player's backpack.
GetSizeGets the size of the player's backpack.
PerformItemDropFunction to handle moving or swapping an item in our inventory. This DOES NOT handle dragging items from any of the character banks or housing hooks. For that functionality please use "PerformShortcutDrop.".
PerformShortcutDropFunction to handle dropping any kind of item into the backpack. If the item is already in the backpack or is coming from a housing hook, it will perform a swap with anything at the destination index.

Events

  NameDescription
ItemAddedEvent fired when an item is added to the backpack.
ItemMovedEvent fired when an item is moved in the backpack.
ItemRemovedEvent fired when an item is removed from the backpack.
SizeChangedEvent fired when the size of the backpack has changed.