EverambleGAME API / 1

CONTENT CONTRACT · VERSION 1

Reference / Effects

consume_item

Explicitly remove a positive quantity from the inventory of a permitted actor.

Feature
authority
Rights
actor_inventory
Debits
none
Conflict
accumulating
Errors
invalid_type faultmissing_reference faultout_of_range faultprecondition_failed rejectionscope_denied faultstale_reference rejectionunknown_field fault

Signature

{ count: PositiveCount, holder: ActorRef, item: ItemId, kind: "consume_item" }

Fields

NameTypeMeaning
countPositiveCountNumber of units; the enclosing operation defines its permitted owner.
Range: 1…2147483647; Unit: count
holderActorRefActor whose inventory changes: the event actor or the invocation owner.
Length: 1…256; Pattern: ^[\s\S]+$
itemItemIdInventory item definition to count, consume or match.
Length: 1…129; Pattern: ^[a-z][a-z0-9_]{0,31}:[a-z][a-z0-9_]{0,95}$; Reference: item
kind"consume_item"Discriminant

Validated example

{
  "count": 1,
  "holder": "a1",
  "item": "core:healing_potion",
  "kind": "consume_item"
}