Skip to content

Class

InventoryOperationRecord

Generated GDScript class reference for ItemVault.InventoryOperationRecord.

Status
Current
Version
v1.1
Source updated
2026-09-12
Generated on
2026-10-12

Source: addons/item_vault/backend/inventory_operation_record.gd

Syntax

class InventoryOperationRecord extends RefCounted

Members

NameKindSummary
SCHEMA_VERSIONFieldVersioned, immutable record of a completed inventory operation. Frozen at emission time. Every command that mutates or queries inventory produces one record on `ItemVaultBus.inventory_operation_record`.
schema_versionPropertyCoarse terminal classification kept alongside the precise result code. `outcome` remains the canonical InventoryResultCode.Code.
operation_idPropertyStable operation ID, monotonic within the backend's lifetime.
session_idPropertyStable session namespace; operation_id is only unique within it, and the pair stays unique across save/load restores.
operation_keyPropertyExternally comparable operation identity.
command_typeProperty
item_idProperty
quantityProperty
source_container_idProperty
target_container_idProperty
currencyProperty
outcomePropertyTyped InventoryResultCode.Code.
outcome_kindPropertyCoarse classification for telemetry and retry handling.
failure_reasonPropertyTyped diagnostic reason independent of outcome.
deltaPropertyDetached typed state delta.
messageProperty
correlation_contextPropertyCaller-supplied opaque correlation context, echoed from the command.
overflow_quantityPropertyOverflow quantity when a partial operation could not fit everything; 0 = none.
item_instance_idPropertyStable item-instance identity, when the operation addresses one retained stack.
instance_idPropertyAlias matching the ItemStack/event field name.
stack_idPropertyConcrete stack boundary identity, distinct from an item-instance identity.
resource_idPropertyNamed retained resource, when the operation addresses one.
resource_deltaPropertySigned retained-resource delta.
resource_old_amountProperty
resource_new_amountProperty
resource_reasonProperty
rollback_quantityPropertyQuantity restored after a rolled-back mutation.
before_snapshotPropertyPre-operation snapshot; null when the inventory was unavailable.
after_snapshotPropertyPost-operation snapshot; null when the inventory was unavailable.
snapshotPropertyAlias for after_snapshot.
final_afterProperty
to_dictMethod