Skip to content
ct

Class

ItemDefinition

Generated GDScript class reference for ItemVault.ItemDefinition.

Status
Draft
Version
v1.0
Updated
Development docs generated from GDScript source

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

Source: addons/item_vault/items/item_definition.gd

Syntax

class ItemDefinition extends Resource

Members

NameKindSummary
idPropertyDefines a type of item in the game — the shared vocabulary that both drops and vault depend on. Serialize as a .tres file and reference by the stable `id` field (never by resource path). Stable key used for persistence (e.g. &"iron_ore"). Never a file path.
display_namePropertyPlayer-facing name shown in UI.
iconPropertyIcon displayed in inventory UI and tooltips.
world_scenePropertyThe scene instanced when this item appears in the game world as a pickup/drop.
max_stackPropertyMaximum quantity per stack (must be > 0).
weightPropertyBase weight per unit (must be >= 0).
categoryPropertyCategory used for filtering, slot constraints, etc.
tagsPropertyArbitrary tags for filtering or game logic.
is_validMethod