Skip to content
ct

Class

InventoryCommandResult

Generated GDScript class reference for ItemVault.InventoryCommandResult.

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/backend/inventory_command_result.gd

Syntax

class InventoryCommandResult extends RefCounted

Members

NameKindSummary
codePropertyResult of applying an [InventoryCommand] to an [InventoryBackend]. Canonical 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.
overflowPropertyLeftover stack when an add/transfer could not fit everything.
affected_quantityPropertyQuantity actually moved/added/removed (0 when the command failed outright).
is_successMethod
is_partialMethod
successMethod
rProperty
failureMethod
rProperty