Inventory System

Inventory System Overview

An inventory is responsible for managing owned items and their quantities. The template provides a basic inventory.tscn scene that can be added to any node. Its data can be saved and loaded using the Save/Load System as is already done for the player.tscn node.

Each Inventory node allows you to assign an action_trigger to open and close the inventory, making it accessible via a user interface. If a UI is not required or you prefer to create your own, you can simply create a new node using the inventory.gd script. This script provides all necessary functions to manage inventory contents, as all items are stored in the items array.

Main Functions

is_item_in_inventory

Checks if an item is in the inventory. Returns the item index if at least one instance of the item exists. If a quantity is specified, it returns the index only if the item exists in the required amount or more.

add_item

Adds an item with the specified quantity to the inventory.

remove_item

Removes the specified quantity of an item from the inventory.

Creating a New Item

Items in this system are Godot resources. To create a new item:

1. Navigate to the items folder in the FileSystem.
2. Right-click and select Create New → Resource….

3. Choose DataItem as the resource type.

4. Type a name for your item and click Save

A DataItem resource allows you to define:

• icon: The visual representation of the item.
• change_hp: Determines whether the item affects HP (only applicable if the node has a HealthController). Use a negative value to decrease HP and a positive value to increase it.
• hide_from_inventory: If enabled, the item is managed by the inventory system but remains hidden in the UI.

Handling Contents

Contents are resources that track the quantity of an item. They are Godot resources of type ContentItem. You usually don’t need to create these manually in the FileSystem, as the inventory system handles them automatically. The items array in the inventory is an array of ContentItem objects.

Other places where ContentItem resources are used:

• get_contents.gd: Used to define a list of items and their quantities (e.g., as seen in chest.tscn).

• StateInteract: When configuring a CheckItems condition to validate required inventory contents in the Conditions section.