Skip to content
ct

Class

ItemFilter

Generated GDScript class reference for ItemVault.ItemFilter.

Status
Current
Version
v1.0
Updated
2026-07-31

Immutable filter for querying items across containers. Uses a fluent builder pattern — each method returns a new filter instance.

Source: addons/item_vault/inventory/item_filter.gd

Syntax

class ItemFilter extends RefCounted

Members

NameKindSummary
item_idPropertyFilter by specific item ID. Empty = any item.
container_idPropertyFilter by specific container ID. Empty = any container.
container_type_idPropertyFilter by container type ID. Empty = any container type.
min_quantityPropertyMinimum quantity (inclusive). -1 = no lower bound.
max_quantityPropertyMaximum quantity (inclusive). -1 = no upper bound.
required_tagsPropertyTags that must ALL be present on the item.
excluded_tagsPropertyTags that must NOT be present on the item.
storage_filter_tagsPropertyStorage filter tags for container-level routing.
by_item_idMethod
in_containerMethod
in_container_typeMethod
min_quantity_at_leastMethod
with_tagsMethod
without_tagsMethod
for_storageMethod
duplicateMethod
with_item_idMethod
with_container_idMethod
with_min_quantityMethod
with_max_quantityMethod
with_required_tagsMethod
with_excluded_tagsMethod
matchesMethod