Skip to content

ItemAcquiredEvent

Items or coins entered a character's inventory.

Full documentation: ItemAcquiredEvent. Wire type: item_acquired.

Default visibility: player

Message codes: exploration.item.acquired

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "Items or coins entered a character's inventory.",
  "properties": {
    "code": {
      "default": "exploration.item.acquired",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "item_acquired",
      "default": "item_acquired",
      "title": "Event Type",
      "type": "string"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    },
    "item_ids": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Item Ids",
      "type": "array"
    },
    "coins_gp_value": {
      "default": 0,
      "title": "Coins Gp Value",
      "type": "integer"
    }
  },
  "required": [
    "character_id"
  ],
  "title": "ItemAcquiredEvent",
  "type": "object"
}