Chris' Tutorials
Docs/Item Vault

Class

ItemFilter

Generated GDScript class reference for ItemVault.ItemFilter.

StatusDraft
Versionv1.0
UpdatedDevelopment docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.

Source: addons/item_vault/inventory/item_filter.gd

Syntax

class ItemFilter extends RefCounted

Members

NameKindSummary
item_idPropertyImmutable filter for querying items across containers. Uses a fluent builder pattern — each method returns a new filter instance. Filter 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
fProperty
in_containerMethod
fProperty
in_container_typeMethod
fProperty
min_quantity_at_leastMethod
fProperty
with_tagsMethod
fProperty
without_tagsMethod
fProperty
for_storageMethod
fProperty
duplicateMethod
fProperty
with_item_idMethod
fProperty
with_container_idMethod
fProperty
with_min_quantityMethod
fProperty
with_max_quantityMethod
fProperty
with_required_tagsMethod
fProperty
with_excluded_tagsMethod
fProperty
matchesMethod
c_idProperty
c_tidProperty
c_tagsProperty
item_tagsProperty

Source

addons/item_vault/inventory/item_filter.gd

Plugin docs root:gdscript/plugins/item_vault_dev/addons/item_vault/guides