Skip to content

item_count_constraint.md

Latest commit

 

History

History
24 lines (15 loc) · 1.05 KB

item_count_constraint.md

File metadata and controls

24 lines (15 loc) · 1.05 KB

ItemCountConstraint

Inherits: InventoryConstraint

Description

A constraint that limits the inventory to a given item stack count.

The constraint implements a count-based inventory where the total number of item stacks cannot exceed the configured capacity of the inventory.

Properties

  • capacity: int - Maximum number of item stacks the inventory can hold.

Methods

  • get_free_space() -> int - Returns the number of item stacks that can be added to the inventory.
  • get_occupied_space() -> int - Returns the total number of item stacks in the inventory.
  • get_space_for(item: InventoryItem) -> int - Returns the number of times this constraint can receive the given item.
  • has_space_for(item: InventoryItem) -> bool - Checks if the constraint can receive the given item.
  • reset() -> void - Resets the constraint, i.e. sets its capacity to default (1).
  • serialize() -> Dictionary - Serializes the constraint into a Dictionary.
  • deserialize(source: Dictionary) -> bool - Loads the constraint data from the given Dictionary.