HoardGeneratedEvent

A lair hoard, carried bundle, or area treasure generated (referee).

Full documentation: HoardGeneratedEvent. Wire type: hoard_generated.

Default visibility: referee

Message codes: treasure.hoard.generated

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": "A lair hoard, carried bundle, or area treasure generated (referee).\n\nReferee visibility \u2014 contents are itemized here and players learn by finding.\n`cache_ref` is the engine-created cache's state reference (or the group id for\ncarried bundles); value and counts summarize the generation.",
  "properties": {
    "code": {
      "default": "treasure.hoard.generated",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "hoard_generated",
      "default": "hoard_generated",
      "title": "Event Type",
      "type": "string"
    },
    "cache_ref": {
      "title": "Cache Ref",
      "type": "string"
    },
    "treasure_types": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Treasure Types",
      "type": "array"
    },
    "coins_gp_value": {
      "default": 0,
      "title": "Coins Gp Value",
      "type": "integer"
    },
    "valuable_ids": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Valuable Ids",
      "type": "array"
    },
    "magic_item_ids": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Magic Item Ids",
      "type": "array"
    }
  },
  "required": [
    "cache_ref"
  ],
  "title": "HoardGeneratedEvent",
  "type": "object"
}