HitPointsReportedEvent

A creature's hit point state — referee visibility: monster HP is hidden by design.

Full documentation: HitPointsReportedEvent. Wire type: hit_points_reported.

Default visibility: referee

Message codes: combat.state.hit_points

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 creature's hit point state \u2014 referee visibility: monster HP is hidden by design.\n\nEmitted alongside damage, healing, death, energy drain, and regeneration \u2014 any\nchange to a creature's current or maximum hit points \u2014 so the referee's view\nstays in sync.",
  "properties": {
    "code": {
      "default": "combat.state.hit_points",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "hit_points_reported",
      "default": "hit_points_reported",
      "title": "Event Type",
      "type": "string"
    },
    "target_id": {
      "title": "Target Id",
      "type": "string"
    },
    "current_hp": {
      "title": "Current Hp",
      "type": "integer"
    },
    "max_hp": {
      "title": "Max Hp",
      "type": "integer"
    }
  },
  "required": [
    "target_id",
    "current_hp",
    "max_hp"
  ],
  "title": "HitPointsReportedEvent",
  "type": "object"
}