Result of applying an [InventoryCommand] to an [InventoryBackend].
Source: addons/item_vault/backend/inventory_command_result.gd
Syntax
class InventoryCommandResult extends RefCountedMembers
| Name | Kind | Summary |
|---|---|---|
code | Property | Canonical result code. |
message | Property | Human-readable message for failures and diagnostics. |
snapshot | Property | Snapshot of the inventory after a successful or partially successful command. |
changes | Property | Incremental change events produced by the command. |
failure_reason | Property | Typed failure diagnostic independent of the canonical result code. |
outcome_kind | Property | Coarse lifecycle classification mirrored by the emitted operation record. |
delta | Property | Detached, typed summary of the state delta. |
overflow | Property | Leftover stack when an add/transfer could not fit everything. |
overflow_stacks | Property | Exact rejected fragments for transfers that span multiple concrete stacks. `overflow` remains the first fragment for backwards compatibility. |
affected_quantity | Property | Quantity actually moved/added/removed (0 when the command failed outright). |
resource_delta | Property | Signed resource delta for retained-instance resource mutations. |
resource_event | Property | Typed event for a committed or duplicate retained-resource command. |
rollback_quantity | Property | Quantity restored after a command rolled back a rejected mutation. |
is_success | Method | |
is_partial | Method | |
success | Method | |
failure | Method |