Skip to content
ct

Class

CraftingRecipe

Generated GDScript class reference for ItemVault.CraftingRecipe.

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

Immutable-by-convention recipe definition describing requirements and outputs by real Item Vault item identity. A recipe is pure data: [member inputs]/[member outputs] reference stable [ItemDefinition.id] values (plus optional definition references on each ingredient). No live inventory, container, or mutable item instance is required to describe a recipe. Fail-closed rules enforced by [method is_valid] and [method from_dict]: empty recipe id / inputs / outputs → invalid non-positive quantities → invalid null ingredients → invalid ingredient definition reference mismatching its id → invalid unsupported schema version (persistence) → invalid Unknown item ids are a database-level check ([method validate_item_ids], used by the registry and the craft service), not a structural one.

Source: addons/item_vault/crafting/recipes/crafting_recipe.gd

Syntax

class CraftingRecipe extends Resource

Members

NameKindSummary
SCHEMA_VERSIONFieldSchema version of the serialized shape. Loaders fail closed on anything else.
idPropertyStable recipe identity. Never a resource path.
display_namePropertyPlayer-facing name shown in UI.
inputsPropertyExact required ingredients (per single craft).
outputsPropertyExact produced outputs (per single craft). May not be empty.
station_tagsPropertyOptional station/tag requirements for consuming games (workbench ids, unlock tags, ...). The module does not interpret these.
schema_versionPropertySerialization schema version. Loaders fail closed on unsupported values.
is_validMethod
validate_item_idsMethod
to_dictMethod
from_dictMethod