Inventory

A collection of item slots for holding items. Provides various ways to change or add items.

Properties

ItemSlot SelectedItemSlot

• Read-Only

• Returns the currently selected slot of this inventory, based on the selected slot index.

bool IsFull

• Read-Only

• Returns true if there are no more empty slots left.

int Size

• Read-Only

• The total size in item slots of this inventory, defined on creation.

int SelectedSlotIndex

• Gets or sets the currently selected slot index of this inventory.

Events

Action<Inventory> InventoryChanged

• Called when anything about the inventory changes. Uses the inventory instance as an argument.

Action<Item> ItemAdded

• Called when an item is introduced into the inventory. Uses the newly added item as an argument.

Action<int> SlotIndexSelected

• Called when the selected slot index is changed. Uses the new selected index as an argument.

Methods

static void TransferInventory(Inventory from, Inventory to)

• Transfers as many items as possible between the two given inventories.

• from The inventory to transfer from.

• to The inventory to transfer to.

void ClearInventory()

• Removes all items from all item slots in the inventory.

bool AddItemToInventory(Item item)

• Adds the given item into the inventory, either by adding to a stack or in an empty slot.

• item The item to add.

bool CreateItemInInventory(int itemID, int count)

• Creates a new instance of an item with the given ID and count inside this inventory.

• itemID The item ID of the item to be created.

• count The count of the item to be created.

bool HasAllItems(params (int, int)[] itemsToMatch)

• Checks whether or not this inventory contains all of the given item IDs and counts.

• itemsToMatch The collection of IDs and counts to check.

bool HasItem(int id, int minimumCount)

• Checks whether or not this inventory contains the given item ID and count.

• itemID The item ID to check.

• minimumCount The count of the item to check.

bool RemoveItems(params (int, int)[] itemsToRemove)

• Removes a set of items by their ID and count from this inventory.

• itemsToRemove The collection of IDs and counts to remove.

bool RemoveItem(int id, int count = 1)

• Removes an item by the given ID and count from this inventory.

• itemID The item ID of the item to remove.

• count The count of the item to remove.

int SlotIndexOf(Item item)

• Attempts to find the slot index within this inventory of the given item.

• item The item to find.