Inventory System

https://expressobits.com/inventory-system
Admin
Inventory System is a plugin that provides comprehensive inventory management, crafting stations,...
Tokens:50,427
Snippets:586
Trust Score:5.4
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build and Install Project

Source: https://expressobits.com/inventory-system/_sources/contributing/cmake_support.rst.txt

Builds the project and installs the built library into the 'bin' folder of the repository using the specified build configuration.

```bash
cmake --build . --target install --config Debug
```

--------------------------------

### Basic Craft Station Setup

Source: https://expressobits.com/inventory-system/manual/craft_stations.html

Connects input and output inventories to the craft station and optionally sets the station type.

```gdscript
# Example: Basic craft station setup in code
@onready var craft_station = $CraftStation
@onready var input_inventory = $InputInventory
@onready var output_inventory = $OutputInventory

func _ready():
    # Connect inventories
    craft_station.add_input_inventory(input_inventory)
    craft_station.output_inventories = [output_inventory.get_path()]

    # Set station type (optional)
    craft_station.type = "furnace"

```

--------------------------------

### Basic Craft Station Setup

Source: https://expressobits.com/inventory-system/_sources/manual/craft_stations.rst.txt

Sets up a basic craft station by connecting input and output inventories and optionally configuring a station type.

```gdscript
# Example: Basic craft station setup in code
@onready var craft_station = $CraftStation
@onready var input_inventory = $InputInventory
@onready var output_inventory = $OutputInventory

func _ready():
    # Connect inventories
    craft_station.add_input_inventory(input_inventory)
    craft_station.output_inventories = [output_inventory.get_path()]
    
    # Set station type (optional)
    craft_station.type = "furnace"
```

--------------------------------

### Start Crafting a Recipe

Source: https://expressobits.com/inventory-system/_sources/manual/craft_stations.rst.txt

Initiates the crafting process for a specific recipe if valid recipes are available.

```gdscript
# Start crafting the first available recipe
if craft_station.valid_recipes.size() > 0:
    craft_station.craft(0)
```

--------------------------------

### Enable Auto Crafting

Source: https://expressobits.com/inventory-system/_sources/manual/craft_stations.rst.txt

Enables the craft station to automatically start crafting when ingredients become available.

```gdscript
# Enable auto-crafting
craft_station.auto_craft = true
```

--------------------------------

### Initialize and Update Git Submodule

Source: https://expressobits.com/inventory-system/getting_started/installation.html

After adding the submodule, run this command to initialize and update it, ensuring all necessary files are downloaded. This is the second step for Git submodule installation.

```bash
git submodule update --init --recursive

```

--------------------------------

### Start Crafting a Recipe

Source: https://expressobits.com/inventory-system/manual/craft_stations.html

Initiates a crafting process by calling the craft() method with a recipe index. Ensure the station has valid recipes and sufficient ingredients before calling.

```gdscript
if craft_station.valid_recipes.size() > 0:
    craft_station.craft(0)
```

--------------------------------

### Smelt All Possible Recipes

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_3_ui.rst.txt

Attempts to start smelting the first available recipe if any valid recipes exist. This is a convenience function for bulk smelting.

```gdscript
func _smelt_all_possible():
    # Try to start smelting if possible
    if craft_station.valid_recipes.size() > 0:
        print("Starting furnace smelting...")
        craft_station.craft(0)
```

--------------------------------

### Add Inventory System as Git Submodule

Source: https://expressobits.com/inventory-system/getting_started/installation.html

Use this command to add the Inventory System repository as a Git submodule to your project's addons directory. This is one method of installation.

```bash
git submodule add https://github.com/expressobits/inventory-system.git addons/inventory-system

```

--------------------------------

### Craft Specific Recipe

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_3_ui.rst.txt

Starts the crafting process for a specific recipe identified by its index in the valid recipes list. Ensures the index is within bounds.

```gdscript
func _craft_recipe(recipe_list_index: int):
    if recipe_list_index < craft_station.valid_recipes.size():
        print("Starting specific recipe: ", recipe_list_index)
        craft_station.craft(recipe_list_index)
```

--------------------------------

### Handle Crafting Started Signal

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_3_ui.rst.txt

Logs a message when a crafting process begins and updates the UI. This signal handler is triggered by the craft station.

```gdscript
func _on_crafting_started(crafting_index: int):
    print("Smelting started: ", crafting_index)
    _update_ui()
```

--------------------------------

### Serialize and Deserialize Inventory

Source: https://expressobits.com/inventory-system/manual/inventories/serialize_inventory.html

Use `inventory.serialize()` to get a dictionary representation of the inventory and `inventory.deserialize()` to load it. Be aware that deserializing will replace the current inventory contents.

```gdscript
# Serialize Inventory
var serialized_inventory : Dictionary = inventory.serialize()

# Deserialize Inventory
inventory.deserialize(serialized_inventory)
```

--------------------------------

### Advanced Craft Station Types

Source: https://expressobits.com/inventory-system/_sources/manual/database/craft_station_type.rst.txt

Illustrates a more complex setup with specialized station types for different crafting tiers and purposes, such as basic and advanced workbenches, and stone and blast furnaces.

```text
CraftStationTypes:
1. ID: "basic_workbench", Name: "Basic Workbench"
2. ID: "advanced_workbench", Name: "Advanced Workbench"
3. ID: "stone_furnace", Name: "Stone Furnace"
4. ID: "blast_furnace", Name: "Blast Furnace"
5. ID: "alchemy_table", Name: "Alchemy Table"
6. ID: "enchanting_table", Name: "Enchanting Table"
```

--------------------------------

### Get Valid ID

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Returns a valid ID for an inventory item.

```APIDOC
## get_valid_id() const

### Description
Returns a valid ID for an inventory item.

### Method
String

### Parameters
None
```

--------------------------------

### Get Item

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Retrieves an item definition using its string ID.

```APIDOC
## get_item(id: String) const

### Description
Retrieves an item definition using its string ID.

### Method
ItemDefinition

### Parameters
#### Path Parameters
- **id** (String) - Required - The string ID of the item to retrieve.
```

--------------------------------

### Initialize Git Submodules

Source: https://expressobits.com/inventory-system/contributing/cmake_support.html

Initializes Git submodules. Run this command in the main repository.

```bash
git submodule init
```

--------------------------------

### Get Category from ID

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Retrieves an item category using its string ID.

```APIDOC
## get_category_from_id(id: String) const

### Description
Retrieves an item category using its string ID.

### Method
ItemCategory

### Parameters
#### Path Parameters
- **id** (String) - Required - The string ID of the category to retrieve.
```

--------------------------------

### Get Category by Code

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Retrieves an item category using its integer code.

```APIDOC
## get_category(code: int)

### Description
Retrieves an item category using its integer code.

### Method
ItemCategory

### Parameters
#### Path Parameters
- **code** (int) - Required - The integer code of the category to retrieve.
```

--------------------------------

### Initialize Git Submodule

Source: https://expressobits.com/inventory-system/_sources/getting_started/installation.rst.txt

After adding the submodule, run this command to initialize and update it, ensuring all necessary files are downloaded and linked correctly.

```pwsh
git submodule update --init --recursive
```

--------------------------------

### Get Inventory Weight

Source: https://expressobits.com/inventory-system/api/class_inventory.html

Calculates and returns the total weight of all items currently in the inventory.

```APIDOC
## get_weight

### Description
Returns the total weight of the inventory, calculated by summing the weight of all items within it.

### Method Signature
`float get_weight() const`
```

--------------------------------

### Get Total Item Count

Source: https://expressobits.com/inventory-system/api/class_inventory.html

Returns the total number of items currently in the inventory.

```APIDOC
## get_amount

### Description
Returns the total count of all items in the inventory.

### Method Signature
`int get_amount() const`
```

--------------------------------

### Get Amount of Item

Source: https://expressobits.com/inventory-system/api/class_inventory.html

Retrieves the total amount of a specific item present in the inventory.

```APIDOC
## amount_of_item

### Description
Returns the total amount of the specified ItemStack in the inventory.

### Method Signature
`int amount_of_item(item_id: String) const`
```

--------------------------------

### Connect to CraftStation Signals

Source: https://expressobits.com/inventory-system/_sources/manual/craft_stations.rst.txt

Connect to various CraftStation signals in _ready() to monitor crafting events like requests, additions, completions, and removals.

```gdscript
func _ready():
    # Connect to crafting signals
    craft_station.on_request_craft.connect(_on_craft_requested)
    craft_station.crafting_added.connect(_on_crafting_added)
    craft_station.on_crafted.connect(_on_craft_completed)
    craft_station.crafting_removed.connect(_on_crafting_removed)

func _on_craft_requested(recipe_index: int):
    print("Craft requested for recipe: ", recipe_index)

func _on_crafting_added(crafting_index: int):
    print("Crafting started: ", crafting_index)

func _on_craft_completed(recipe_index: int):
    print("Craft completed for recipe: ", recipe_index)

func _on_crafting_removed(crafting_index: int):
    print("Crafting removed: ", crafting_index)
```

--------------------------------

### Get New Valid ID

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Generates and returns a new valid ID for an inventory item.

```APIDOC
## get_new_valid_id() const

### Description
Generates and returns a new valid ID for an inventory item.

### Method
String

### Parameters
None
```

--------------------------------

### QuadTree.init

Source: https://expressobits.com/inventory-system/api/class_quadtree.html

Initializes the QuadTree with a specified size. This method must be called before adding any elements to the tree.

```APIDOC
## QuadTree.init

### Description
Initializes the QuadTree with a specified size. This method must be called before adding any elements to the tree.

### Method
init

### Parameters
#### Path Parameters
- **size** (Vector2i) - Required - The initial size of the QuadTree.
```

--------------------------------

### Handle Player Input for Crafting

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_2_nodes.rst.txt

Initiates crafting when the 'ui_accept' action is pressed, provided there are valid recipes. Otherwise, it prints a message indicating no recipes are available.

```gdscript
func _input(event):
   if event.is_action_pressed("ui_accept"):
      if craft_station.valid_recipes.size() > 0:
         print("Starting crafting...")
         craft_station.craft(1)
      else:
         print("No recipes available!")
```

--------------------------------

### Get Item Count by Category

Source: https://expressobits.com/inventory-system/api/class_inventory.html

Retrieves the total amount of items belonging to a specific category within the inventory.

```APIDOC
## get_amount_of_category

### Description
Returns the total amount of items belonging to the specified ItemCategory.

### Method Signature
`int get_amount_of_category(category: ItemCategory) const`
```

--------------------------------

### QuadNode Methods

Source: https://expressobits.com/inventory-system/api/class_quadnode.html

This section details the methods available for interacting with QuadNode objects.

```APIDOC
## add

### Description
Adds a QuadRect to the QuadNode.

### Method
`void add(quad_rect: QuadRect)`

### Parameters
- **quad_rect** (QuadRect) - The QuadRect to add.

### Method

## can_subdivide

### Description
Checks if a QuadNode can be subdivided based on a given size.

### Method
`bool can_subdivide(size: Vector2i) static`

### Parameters
- **size** (Vector2i) - The size to check for subdivision.

### Returns
- `bool` - True if the node can be subdivided, false otherwise.

### Method

## get_all_containing_point

### Description
Retrieves all QuadRects within the QuadNode that contain the given point.

### Method
`Array get_all_containing_point(point: Vector2i, exception_metadata: Variant = null) const`

### Parameters
- **point** (Vector2i) - The point to check for containment.
- **exception_metadata** (Variant) - Optional metadata for exceptions.

### Returns
- `Array` - An array of QuadRects containing the point.

### Method

## get_all_under_rect

### Description
Retrieves all QuadRects within the QuadNode that are under the given test rectangle.

### Method
`Array get_all_under_rect(test_rect: Rect2i, exception_metadata: Variant = null) const`

### Parameters
- **test_rect** (Rect2i) - The rectangle to test against.
- **exception_metadata** (Variant) - Optional metadata for exceptions.

### Returns
- `Array` - An array of QuadRects under the test rectangle.

### Method

## get_first_containing_point

### Description
Retrieves the first QuadRect within the QuadNode that contains the given point.

### Method
`QuadRect get_first_containing_point(point: Vector2i, exception_metadata: Variant = null) const`

### Parameters
- **point** (Vector2i) - The point to check for containment.
- **exception_metadata** (Variant) - Optional metadata for exceptions.

### Returns
- `QuadRect` - The first QuadRect containing the point.

### Method

## get_first_under_rect

### Description
Retrieves the first QuadRect within the QuadNode that is under the given test rectangle.

### Method
`QuadRect get_first_under_rect(test_rect: Rect2i, exception_metadata: Variant = null) const`

### Parameters
- **test_rect** (Rect2i) - The rectangle to test against.
- **exception_metadata** (Variant) - Optional metadata for exceptions.

### Returns
- `QuadRect` - The first QuadRect under the test rectangle.

### Method

## get_quadrant_rects

### Description
Calculates the rectangle regions for the quadrants of a given rectangle.

### Method
`Array[Rect2i] get_quadrant_rects(rect: Rect2i) static`

### Parameters
- **rect** (Rect2i) - The rectangle for which to calculate quadrant rects.

### Returns
- `Array[Rect2i]` - An array of Rect2i representing the quadrant rectangles.

### Method

## is_empty

### Description
Checks if the QuadNode is empty.

### Method
`bool is_empty() const`

### Returns
- `bool` - True if the node is empty, false otherwise.

### Method

## remove

### Description
Removes an item from the QuadNode based on its metadata.

### Method
`bool remove(metadata: Variant)`

### Parameters
- **metadata** (Variant) - The metadata of the item to remove.

### Returns
- `bool` - True if the item was removed, false otherwise.

### Method
```

--------------------------------

### on_request_craft

Source: https://expressobits.com/inventory-system/api/class_craftstation.html

Emitted when a Crafting is requested, unlike crafting_added, this signal can happen even when the crafting cannot be done. This signal is emitted at the start of the craft() method.

```APIDOC
## Signal: on_request_craft

### Description
Emitted when a Crafting is requested. Unlike `crafting_added`, this signal can happen even when the crafting cannot be done. This signal is emitted at the start of the `craft()` method.

### Parameters
* **recipe_index** (`int`) - The index of the requested crafting recipe.
```

--------------------------------

### Handle Crafting Completion and Show Output

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_2_nodes.rst.txt

Prints a completion message and iterates through the output inventory to display the items produced by the crafting process.

```gdscript
func _on_craft_completed(recipe_index: int):
   print("Crafting completed!")

   # Show output
   for i in output_inventory.stacks.size():
      var stack = output_inventory.stacks[i]
      if stack:
         print("Produced: ", stack.amount, "x ", stack.item_id)
```

--------------------------------

### Assigning CraftStationType to a CraftStation in Code

Source: https://expressobits.com/inventory-system/manual/database/craft_station_type.html

Demonstrates how to load a specific CraftStationType by its ID from the database and assign it to a CraftStation node's type property in code. This ensures the station processes matching recipes.

```gdscript
# Example: Setting station type in code
@onready var craft_station = $CraftStation

func _ready():
    # Load a specific station type from the database
    var station_type = database.get_craft_station_type_by_id("furnace")
    craft_station.type = station_type

```

--------------------------------

### Hotbar Methods

Source: https://expressobits.com/inventory-system/api/class_hotbar.html

Methods available for interacting with the player's hotbar.

```APIDOC
## active_slot

### Description
Activates a specific slot in the hotbar.

### Method
`void active_slot(slot_index: int)`

### Parameters
* **slot_index** (int) - The index of the slot to activate.

### Method Description
void active_slot(slot_index: `int`)
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## deactive_slot

### Description
Deactivates a specific slot in the hotbar.

### Method
`void deactive_slot(slot_index: int)`

### Parameters
* **slot_index** (int) - The index of the slot to deactivate.

### Method Description
void deactive_slot(slot_index: `int`)
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## equip

### Description
Equips an ItemStack to a specified slot in the hotbar.

### Method
`void equip(stack: ItemStack, slot_index: int)`

### Parameters
* **stack** (ItemStack) - The ItemStack to equip.
* **slot_index** (int) - The index of the slot to equip the item to.

### Method Description
void equip(stack: ItemStack, slot_index: `int`)
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## get_inventory

### Description
Retrieves the Inventory object associated with this hotbar.

### Method
`Inventory get_inventory() const`

### Returns
* **Inventory** - The Inventory object.

### Method Description
Inventory get_inventory() const
Returns the Inventory that is related to this hotbar.

```

```APIDOC
## get_stack_on_selection

### Description
Gets the ItemStack currently selected in the hotbar.

### Method
`ItemStack get_stack_on_selection() const`

### Returns
* **ItemStack** - The ItemStack on the current selection.

### Method Description
ItemStack get_stack_on_selection() const
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## get_stack_on_slot

### Description
Gets the ItemStack present in a specific slot of the hotbar.

### Method
`ItemStack get_stack_on_slot(slot_index: int) const`

### Parameters
* **slot_index** (int) - The index of the slot to retrieve the ItemStack from.

### Returns
* **ItemStack** - The ItemStack in the specified slot.

### Method Description
ItemStack get_stack_on_slot(slot_index: `int`) const
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## has_valid_stack_on_selection

### Description
Checks if there is a valid ItemStack on the currently selected hotbar slot.

### Method
`bool has_valid_stack_on_selection() const`

### Returns
* **bool** - True if a valid ItemStack is present, false otherwise.

### Method Description
bool has_valid_stack_on_selection() const
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## has_valid_stack_on_slot

### Description
Checks if a specific slot in the hotbar contains a valid ItemStack.

### Method
`bool has_valid_stack_on_slot(slot_index: int) const`

### Parameters
* **slot_index** (int) - The index of the slot to check.

### Returns
* **bool** - True if the slot contains a valid ItemStack, false otherwise.

### Method Description
bool has_valid_stack_on_slot(slot_index: `int`) const
There is currently no description for this method. Please help us by contributing one!

```

```APIDOC
## is_active_slot

### Description
Checks if a specific slot in the hotbar is currently active.

### Method
`bool is_active_slot(slot_index: int) const`

### Parameters
* **slot_index** (int) - The index of the slot to check.

### Returns
* **bool** - True if the slot is active, false otherwise.

### Method Description
bool is_active_slot(slot_index: `int`) const
Returns true if a valid ItemStack is in the current selection.

```

```APIDOC
## next_item

### Description
Switches the hotbar selection to the next item.

### Method
`void next_item()`

### Method Description
void next_item()
Switches from the current selection_index to the next selection.

```

```APIDOC
## previous_item

### Description
Switches the hotbar selection to the previous item.

### Method
`void previous_item()`

### Method Description
void previous_item()
Switches from the current selection_index to the previous selection.

```

```APIDOC
## unequip

### Description
Unequips an item from a specified slot in the hotbar.

### Method
`void unequip(slot_index: int)`

### Parameters
* **slot_index** (int) - The index of the slot to unequip from.

### Method Description
void unequip(slot_index: `int`)
There is currently no description for this method. Please help us by contributing one!

```

--------------------------------

### Get Stack Index by Category

Source: https://expressobits.com/inventory-system/api/class_inventory.html

Finds and returns the index of the first stack containing an item of a specified category. Returns -1 if no such stack is found.

```APIDOC
## get_stack_index_with_an_item_of_category

### Description
Returns the index of the first stack that contains an item of the specified ItemCategory. If no stack contains an item of this category, it returns -1.

### Method Signature
`int get_stack_index_with_an_item_of_category(category: ItemCategory) const`
```

--------------------------------

### GridInventory Methods

Source: https://expressobits.com/inventory-system/api/class_gridinventory.html

This section details the various methods available for interacting with the GridInventory, such as adding items, checking capacities, and manipulating item positions.

```APIDOC
## add_at_position

### Description
Adds an item to a specific position in the grid inventory.

### Signature
`int add_at_position(position: Vector2i, item_id: String, amount: int = 1, properties: Dictionary = {}, is_rotated: bool = false)`

### Parameters
- **position** (Vector2i) - The grid position to add the item to.
- **item_id** (String) - The ID of the item to add.
- **amount** (int, optional) - The quantity of the item to add. Defaults to 1.
- **properties** (Dictionary, optional) - Additional properties for the item. Defaults to an empty dictionary.
- **is_rotated** (bool, optional) - Whether the item is rotated. Defaults to false.

### Returns
(int) - The amount of the item successfully added.
```

```APIDOC
## can_rotate_item

### Description
Checks if an item stack can be rotated within the inventory.

### Signature
`bool can_rotate_item(stack: ItemStack) const`

### Parameters
- **stack** (ItemStack) - The item stack to check for rotation.

### Returns
(bool) - True if the item can be rotated, false otherwise.
```

```APIDOC
## get_quad_tree

### Description
Retrieves the QuadTree associated with the grid inventory, used for spatial partitioning.

### Signature
`QuadTree get_quad_tree() const`

### Returns
(QuadTree) - The QuadTree instance.
```

```APIDOC
## get_stack_at

### Description
Gets the item stack located at a specific position in the grid.

### Signature
`ItemStack get_stack_at(position: Vector2i) const`

### Parameters
- **position** (Vector2i) - The grid position to query.

### Returns
(ItemStack) - The item stack at the specified position, or null if empty.
```

```APIDOC
## get_stack_index_at

### Description
Gets the index of the item stack at a specific position in the grid.

### Signature
`int get_stack_index_at(position: Vector2i) const`

### Parameters
- **position** (Vector2i) - The grid position to query.

### Returns
(int) - The index of the item stack, or -1 if no stack is present.
```

```APIDOC
## get_stack_position

### Description
Retrieves the grid position of a given item stack.

### Signature
`Vector2i get_stack_position(stack: ItemStack) const`

### Parameters
- **stack** (ItemStack) - The item stack whose position is to be found.

### Returns
(Vector2i) - The grid position of the item stack.
```

```APIDOC
## get_stack_rect

### Description
Calculates the rectangular area occupied by an item stack in the grid.

### Signature
`Rect2i get_stack_rect(stack: ItemStack) const`

### Parameters
- **stack** (ItemStack) - The item stack for which to get the rectangle.

### Returns
(Rect2i) - The rectangular area occupied by the stack.
```

```APIDOC
## get_stack_size

### Description
Returns the size (dimensions) of an item stack.

### Signature
`Vector2i get_stack_size(stack: ItemStack) const`

### Parameters
- **stack** (ItemStack) - The item stack to get the size of.

### Returns
(Vector2i) - The size of the item stack.
```

```APIDOC
## get_stacks_under

### Description
Retrieves all item stacks that are fully or partially under a given rectangular area.

### Signature
`Array[ItemStack] get_stacks_under(rect: Rect2i) const`

### Parameters
- **rect** (Rect2i) - The rectangular area to check.

### Returns
(Array[ItemStack]) - An array of item stacks found under the specified rectangle.
```

```APIDOC
## has_free_place

### Description
Checks if there is enough free space in the inventory to place an item of a given size.

### Signature
`bool has_free_place(stack_size: Vector2i, exception: ItemStack = null) const`

### Parameters
- **stack_size** (Vector2i) - The size of the item stack to check for.
- **exception** (ItemStack, optional) - An item stack to exclude from the check (e.g., the item being moved). Defaults to null.

### Returns
(bool) - True if free space is available, false otherwise.
```

```APIDOC
## is_stack_rotated

### Description
Determines if a given item stack is currently rotated.

### Signature
`bool is_stack_rotated(stack: ItemStack) const`

### Parameters
- **stack** (ItemStack) - The item stack to check.

### Returns
(bool) - True if the stack is rotated, false otherwise.
```

```APIDOC
## rect_free

### Description
Checks if a given rectangular area in the grid is completely free.

### Signature
`bool rect_free(rect: Rect2i, exception: ItemStack = null) const`

### Parameters
- **rect** (Rect2i) - The rectangular area to check.
- **exception** (ItemStack, optional) - An item stack to exclude from the check. Defaults to null.

### Returns
(bool) - True if the rectangle is free, false otherwise.
```

```APIDOC
## rotate

### Description
Rotates an item stack within the inventory.

### Signature
`void rotate(stack: ItemStack)`

### Parameters
- **stack** (ItemStack) - The item stack to rotate.
```

```APIDOC
## set_quad_tree

### Description
Sets the QuadTree for the grid inventory.

### Signature
`void set_quad_tree(quad_tree: QuadTree)`

### Parameters
- **quad_tree** (QuadTree) - The QuadTree to set.
```

```APIDOC
## set_stack_position

### Description
Attempts to set a new position for an item stack.

### Signature
`bool set_stack_position(stack: ItemStack, new_position: Vector2i)`

### Parameters
- **stack** (ItemStack) - The item stack to move.
- **new_position** (Vector2i) - The desired new position.

### Returns
(bool) - True if the position was successfully set, false otherwise.
```

```APIDOC
## sort

### Description
Sorts the items within the grid inventory.

### Signature
`bool sort()`

### Returns
(bool) - True if the sort was successful, false otherwise.
```

```APIDOC
## swap_stacks

### Description
Swaps the positions of two item stacks within the same inventory or between inventories.

### Signature
`bool swap_stacks(position: Vector2i, other_inventory: GridInventory, other_position: Vector2i)`

### Parameters
- **position** (Vector2i) - The position of the first item stack.
- **other_inventory** (GridInventory) - The inventory containing the second item stack.
- **other_position** (Vector2i) - The position of the second item stack.

### Returns
(bool) - True if the swap was successful, false otherwise.
```

```APIDOC
## transfer_to

### Description
Transfers items from one position in this inventory to a position in another inventory.

### Signature
`int transfer_to(from_position: Vector2i, destination: GridInventory, destination_position: Vector2i, amount: int = 1, is_rotated: bool = false)`

### Parameters
- **from_position** (Vector2i) - The starting position in the current inventory.
- **destination** (GridInventory) - The target inventory.
- **destination_position** (Vector2i) - The target position in the destination inventory.
- **amount** (int, optional) - The amount of items to transfer. Defaults to 1.
- **is_rotated** (bool, optional) - Whether the transferred items should be rotated. Defaults to false.

### Returns
(int) - The amount of items successfully transferred.
```

--------------------------------

### Serialization

Source: https://expressobits.com/inventory-system/api/class_craftstation.html

Methods for serializing and deserializing the CraftStation's state.

```APIDOC
## serialize

### Description
Serializes the current state of the CraftStation into a dictionary.

### Method
`Dictionary` const
```

```APIDOC
## deserialize

### Description
Deserializes the CraftStation's state from a dictionary.

### Method
`void`

### Parameters
- **data** (`Dictionary`) - The dictionary containing the state data.
```

--------------------------------

### Get Item Definition by ID (GDScript)

Source: https://expressobits.com/inventory-system/_sources/manual/database/item_definition.rst.txt

Retrieve an item definition from the inventory database using its unique ID. This is a common operation when interacting with inventory items.

```gdscript
var db: InventoryDatabase
var def: ItemDefinition = db.get_item("my_item_id") # Get item definition by id
```

```gdscript
# Code in a node that extends NodeInventories (Inventory, CraftStation, etc)
var def: ItemDefinition = db.get_item_from_id("my_item_id") # Get item definition by id
```

--------------------------------

### Create Recipe Buttons Dynamically

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_3_ui.rst.txt

Clears existing buttons and creates new ones for each available furnace recipe. Updates button text and connects the press signal to the _craft_recipe function.

```gdscript
func _create_recipe_buttons():
    # Clear existing buttons
    for button in recipe_buttons:
        button.queue_free()
    recipe_buttons.clear()

    # Create button for each furnace recipe
    for i in craft_station.valid_recipes.size():
        var recipe_index = craft_station.valid_recipes[i]
        var recipe = craft_station.database.recipes[recipe_index]

        var button = Button.new()
        var product_name = recipe.products[0].item_id if recipe.products.size() > 0 else "Unknown"
        button.text = "Smelt " + product_name

        button.pressed.connect(_craft_recipe.bind(i))
        recipes_list.add_child(button)
        recipe_buttons.append(button)
```

--------------------------------

### Import JSON File

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Imports inventory data from a JSON file at the specified path.

```APIDOC
## import_json_file(path: String)

### Description
Imports inventory data from a JSON file at the specified path.

### Method
Error

### Parameters
#### Path Parameters
- **path** (String) - Required - The file path to import the JSON data from.
```

--------------------------------

### Add Recipe

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Adds a new recipe to the inventory database.

```APIDOC
## add_recipe()

### Description
Adds a new recipe to the inventory database.

### Method
void

### Parameters
None
```

--------------------------------

### Inventory Methods

Source: https://expressobits.com/inventory-system/api/class_inventory.html

This section details the methods available for interacting with the Inventory class, allowing for item management, stack manipulation, and inventory state queries.

```APIDOC
## Inventory Class Methods

This document outlines the methods available for the `Inventory` class, which manages item stacks within a container.

### Methods

- `int add(item_id: String, amount: int = 1, properties: Dictionary = {}, drop_excess: bool = false, can_emit_item_added_signal: bool = true)`
  Adds an item to the inventory. If `drop_excess` is true and the item cannot fit, excess will be dropped. Returns the actual amount added.

- `int add_at_index(stack_index: int, item_id: String, amount: int = 1, properties: Dictionary = {}, can_emit_item_added_signal: bool = true)`
  Adds an item to a specific stack index. Returns the actual amount added.

- `int add_on_new_stack(item_id: String, amount: int = 1, properties: Dictionary = {}, can_emit_stack_added_signal: bool = true, can_emit_item_added_signal: bool = true)`
  Adds an item, creating a new stack if necessary. Returns the actual amount added.

- `int add_to_stack(stack: ItemStack, item_id: String, amount: int = 1, properties: Dictionary = {}, can_emit_item_added_signal: bool = true)`
  Adds an item to a specific `ItemStack` object. Returns the actual amount added.

- `int amount_of_item(item_id: String) const`
  Returns the total amount of a specific item ID in the inventory.

- `bool can_add_new_stack(item_id: String, amount: int = 1, properties: Dictionary = {}) const`
  Checks if a new stack can be created with the given item and amount.

- `void clear()`
  Removes all items from the inventory.

- `bool contains(item_id: String, amount: int = 1) const`
  Checks if the inventory contains at least the specified amount of an item.

- `bool contains_at(stack_index: int, item_id: String, amount: int = 1) const`
  Checks if a specific stack index contains at least the specified amount of an item.

- `bool contains_category(category: ItemCategory, amount: int = 1) const`
  Checks if the inventory contains at least the specified amount of items belonging to a category.

- `bool contains_category_in_stack(stack: ItemStack, category: ItemCategory) const`
  Checks if a specific `ItemStack` belongs to a given category.

- `void deserialize(data: Dictionary)`
  Deserializes the inventory state from a dictionary.

- `bool drop(item_id: String, amount: int = 1, properties: Dictionary = {})`
  Drops a specified amount of an item from the inventory. Returns true if successful.

- `void drop_all_stacks()`
  Removes all item stacks from the inventory.

- `void drop_from_inventory(stack_index: int, amount: int = 1, properties: Dictionary = {})`
  Removes a specified amount of items from a specific stack index.

- `int get_amount() const`
  Returns the total number of item stacks in the inventory.

- `int get_amount_of_category(category: ItemCategory) const`
  Returns the total amount of items belonging to a specific category.

- `int get_stack_index_with_an_item_of_category(category: ItemCategory) const`
  Returns the index of a stack containing an item of the specified category, or -1 if none found.

- `float get_weight() const`
  Returns the total weight of all items in the inventory.

- `bool has_space_for(item: String, amount: int = 1, properties: Dictionary = {}) const`
  Checks if there is enough space in the inventory for a given item and amount.

- `bool has_stack(stack: ItemStack) const`
  Checks if the inventory contains a specific `ItemStack` object.

- `bool is_empty() const`
  Checks if the inventory is empty.

- `bool is_full() const`
  Checks if the inventory is full.

- `int remove(item_id: String, amount: int = 1)`
  Removes a specified amount of an item from the inventory. Returns the actual amount removed.

- `int remove_at(stack_index: int, item_id: String, amount: int = 1)`
  Removes a specified amount of an item from a specific stack index. Returns the actual amount removed.

- `int remove_from_stack(stack: ItemStack, item_id: String, amount: int = 1)`
  Removes a specified amount of an item from a specific `ItemStack` object. Returns the actual amount removed.

- `void remove_stack(stack_index: int)`
  Removes an entire stack from the inventory at the specified index.

- `Dictionary serialize() const`
  Serializes the inventory state into a dictionary.

- `void set_stack_content(stack_index: int, item_id: String, amount: int = 1, properties: Dictionary = {})`
  Sets the content of a specific stack index.

- `bool split(stack_index: int, amount: int = 1)`
  Splits a stack at the specified index, creating a new stack with the given amount. Returns true if successful.

- `int transfer(stack_index: int, destination: Inventory, amount: int = 1)`
  Transfers a specified amount of items from a stack in this inventory to a destination inventory. Returns the actual amount transferred.

- `int transfer_at(stack_index: int, destination: Inventory, destination_stack_index: int, amount: int = 1)`
  Transfers a specified amount of items from a stack in this inventory to a specific stack in a destination inventory. Returns the actual amount transferred.

- `void update_stack(stack_index: int)`
  Updates the stack at the specified index. This might be used to refresh item properties or counts.
```

--------------------------------

### Get Item Definition by ID using InventoryDatabase

Source: https://expressobits.com/inventory-system/manual/database/item_definition.html

Retrieve an item definition from the database using its unique string ID. This is a common operation when you need to access item properties.

```gdscript
var db: InventoryDatabase
var def: ItemDefinition = db.get_item("my_item_id") # Get item definition by id

```

--------------------------------

### Initialize Git Submodules

Source: https://expressobits.com/inventory-system/_sources/contributing/cmake_support.rst.txt

Initializes and updates git submodules. This is a prerequisite for the CMake build process.

```bash
git submodule init
```

```bash
git submodule update
```

--------------------------------

### Create Buttons for Crafting Recipes

Source: https://expressobits.com/inventory-system/tutorials/craft_station_tutorial_3_ui.html

Iterates through available recipes to create and configure buttons for each. Connects the button's pressed signal to the crafting function.

```gdscript
for i in craft_station.valid_recipes.size():
    var recipe_index = craft_station.valid_recipes[i]
    var recipe = craft_station.database.recipes[recipe_index]

    var button = Button.new()
    var product_name = recipe.products[0].item_id if recipe.products.size() > 0 else "Unknown"
    button.text = "Smelt " + product_name

    button.pressed.connect(_craft_recipe.bind(i))
    recipes_list.add_child(button)
    recipe_buttons.append(button)
```

--------------------------------

### craft

Source: https://expressobits.com/inventory-system/api/class_craftstation.html

Initiates a new crafting process using a recipe specified by its index from the list of valid recipes. The craft is added to the `member.craftings` list only if the `contains_ingredients()` method returns true.

```APIDOC
## craft

### Description
Calls a new craft with recipe from index `recipe_index` of valid_recipes to be processed (added to the `member.craftings` list). Note: It will only be included if contains_ingredients() is true.

### Method
void

### Parameters
- **recipe_index** (`int`) - The index of the recipe in the valid_recipes list to craft.
```

--------------------------------

### _get_amount_to_add

Source: https://expressobits.com/inventory-system/api/class_inventoryconstraint.html

This function can be implemented to override the quantity that should be added to each inventory add interaction. Useful for limiting quantities, for example, in processor-linked inventories. Returns the amount of item_id to be added to the inventory.

```APIDOC
## _get_amount_to_add

### Description
This function can be implemented to override the quantity that should be added to each inventory add interaction.
Useful when you want to limit the quantity that the inventory receives, for example an inventory linked to a processor and receives one item at a time, or does not receive anything if it is processing something.
Returns int with amount of `item_id` added in inventory.

### Method
virtual

### Parameters
- **inventory** (Node) - Description
- **item_id** (String) - Description
- **amount** (int) - Description
- **properties** (Dictionary) - Description
```

--------------------------------

### Get Item Definition by ID from NodeInventories

Source: https://expressobits.com/inventory-system/manual/database/item_definition.html

Access an item definition directly from nodes that extend NodeInventories (like Inventory or CraftStation) using its ID. This provides a convenient shortcut for item retrieval within these nodes.

```gdscript
# Code in a node that extends NodeInventories (Inventory, CraftStation, etc)
var def: ItemDefinition = db.get_item_from_id("my_item_id") # Get item definition by id

```

--------------------------------

### Add Inventory System as Git Submodule

Source: https://expressobits.com/inventory-system/_sources/getting_started/installation.rst.txt

Use this command to add the Inventory System plugin as a Git submodule to your project's addons directory. This is useful for managing external dependencies.

```pwsh
git submodule add https://github.com/expressobits/inventory-system.git addons/inventory-system
```

--------------------------------

### Handle Accept Input for Smelting

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_3_ui.rst.txt

Triggers the "smelt all possible" action when the 'ui_accept' action is pressed, typically by pressing the space bar. This maintains functionality from previous tutorials.

```gdscript
func _input(event):
    if event.is_action_pressed("ui_accept"):
        _smelt_all_possible()
```

--------------------------------

### serialize_recipe

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Serializes a Recipe into a Dictionary for storage.

```APIDOC
## serialize_recipe

### Description
Serializes a Recipe into a Dictionary for storage.

### Method
Dictionary const

### Parameters
* **recipe** (Recipe) - Required - The Recipe to serialize.

### Return Value
Dictionary
```

--------------------------------

### Configure Craft Station Limits

Source: https://expressobits.com/inventory-system/_sources/manual/craft_stations.rst.txt

Enables and sets the maximum number of concurrent crafts allowed for a craft station.

```gdscript
# Enable craft limits
craft_station.has_limit_crafts = true
craft_station.limit_number_crafts = 3
```

--------------------------------

### List Available Recipes and Crafting Status

Source: https://expressobits.com/inventory-system/_sources/tutorials/craft_station_tutorial_2_nodes.rst.txt

Iterates through available recipes, prints their product names, and indicates if they can be crafted. This is useful for debugging and understanding the current state of the craft station.

```gdscript
for i in craft_station.valid_recipes.size():
   var recipe_index = craft_station.valid_recipes[i]
   var recipe = craft_station.database.recipes[recipe_index]
   var product_name = recipe.products[0].item_id if recipe.products.size() > 0 else "Unknown"
   print("Recipe ", i, ": ", product_name)
   
   var can_craft = craft_station.can_craft(recipe)
   print("  Can craft: ", can_craft)
```

--------------------------------

### load_valid_recipes

Source: https://expressobits.com/inventory-system/api/class_craftstation.html

Loads the valid crafting recipes for the station. The specific implementation details are not provided in the source.

```APIDOC
## load_valid_recipes

### Description
There is currently no description for this method. Please help us by contributing one!

### Method
void
```

--------------------------------

### Check Recipe Availability

Source: https://expressobits.com/inventory-system/_sources/manual/craft_stations.rst.txt

Iterate through valid recipes and check if each can be crafted using the craft_station.can_craft() method.

```gdscript
# Get available recipes
for recipe_index in craft_station.valid_recipes:
    var recipe = database.recipes[recipe_index]
    var can_craft = craft_station.can_craft(recipe)
    print("Recipe: ", recipe.name, " - Can craft: ", can_craft)
```

--------------------------------

### Inventory Management

Source: https://expressobits.com/inventory-system/api/class_craftstation.html

Methods for managing input inventories for the CraftStation.

```APIDOC
## add_input_inventory

### Description
Adds an inventory to the list of input inventories for the station.

### Method
`void`

### Parameters
- **input_inventory** (`Inventory`) - The inventory to add.
```

```APIDOC
## remove_input_inventory

### Description
Removes an inventory from the list of input inventories.

### Method
`void`

### Parameters
- **input_inventory** (`Inventory`) - The inventory to remove.
```

```APIDOC
## get_input_inventory

### Description
Retrieves an input inventory by its index.

### Method
`Inventory` const

### Parameters
- **index** (`int`) - Optional. The index of the input inventory to retrieve. Defaults to 0.
```

--------------------------------

### add_crafting

Source: https://expressobits.com/inventory-system/api/class_craftstation.html

Adds a new crafting process with a specified recipe index and recipe data to the station's crafting process list. Emits the crafting_added signal upon successful addition.

```APIDOC
## add_crafting

### Description
Adds a new crafting process with the `recipe` index `recipe_index` to the station’s crafting process list. It emits the signal crafting_added.

### Method
void

### Parameters
- **recipe_index** (`int`) - Description of the recipe index.
- **recipe** (`Recipe`) - The recipe object to add.
```

--------------------------------

### Deserialize Recipe

Source: https://expressobits.com/inventory-system/api/class_inventorydatabase.html

Deserializes recipe data from a dictionary.

```APIDOC
## deserialize_recipe(recipe: Recipe, data: Dictionary) const

### Description
Deserializes recipe data from a dictionary.

### Method
void

### Parameters
#### Path Parameters
- **recipe** (Recipe) - Required - The Recipe object to populate.
- **data** (Dictionary) - Required - The dictionary containing the recipe data.
```
Tokens:
Raw