Skip to content
ct

Class

InventoryCommandResult

Generated GDScript class reference for ItemVault.InventoryCommandResult.

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

Result of applying an [InventoryCommand] to an [InventoryBackend].

Source: addons/item_vault/backend/inventory_command_result.gd

Syntax

class InventoryCommandResult extends RefCounted

Members

NameKindSummary
codePropertyCanonical result code.
messagePropertyHuman-readable message for failures and diagnostics.
snapshotPropertySnapshot of the inventory after a successful or partially successful command.
changesPropertyIncremental change events produced by the command.
failure_reasonPropertyTyped failure diagnostic independent of the canonical result code.
outcome_kindPropertyCoarse lifecycle classification mirrored by the emitted operation record.
deltaPropertyDetached, typed summary of the state delta.
overflowPropertyLeftover stack when an add/transfer could not fit everything.
overflow_stacksPropertyExact rejected fragments for transfers that span multiple concrete stacks. `overflow` remains the first fragment for backwards compatibility.
affected_quantityPropertyQuantity actually moved/added/removed (0 when the command failed outright).
resource_deltaPropertySigned resource delta for retained-instance resource mutations.
resource_eventPropertyTyped event for a committed or duplicate retained-resource command.
rollback_quantityPropertyQuantity restored after a command rolled back a rejected mutation.
is_successMethod
is_partialMethod
successMethod
failureMethod