UndeadTurnedEvent

A turning attempt resolved — player visibility: the player rolls turning dice.

Full documentation: UndeadTurnedEvent. Wire type: undead_turned.

Default visibility: player

Message codes: magic.turning.destroyed, magic.turning.failed, magic.turning.turned

JSON Schema

{
  "$defs": {
    "TurningTypeOutcome": {
      "description": "One undead type's turning verdict: its column, the cell, and the threshold.",
      "properties": {
        "template_id": {
          "title": "Template Id",
          "type": "string"
        },
        "column": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Column"
        },
        "outcome": {
          "title": "Outcome",
          "type": "string"
        },
        "threshold": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Threshold"
        }
      },
      "required": [
        "template_id",
        "outcome"
      ],
      "title": "TurningTypeOutcome",
      "type": "object"
    },
    "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 turning attempt resolved \u2014 player visibility: the player rolls turning dice.\n\nEmitted by [`turn_undead`][osrlib.core.spells.turn_undead].\n\nCarries the 2d6 turn roll, the 2d6 HD pool when one was rolled (some type\nsucceeded), the per-type verdicts, and the affected monsters. Per-monster\nconsequences ride `ConditionGainedEvent`/`DeathEvent`. The code is `failed` when\nno type succeeded, `destroyed` when any affected monster was destroyed, and\n`turned` otherwise.",
  "properties": {
    "code": {
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "undead_turned",
      "default": "undead_turned",
      "title": "Event Type",
      "type": "string"
    },
    "caster_id": {
      "title": "Caster Id",
      "type": "string"
    },
    "roll": {
      "title": "Roll",
      "type": "integer"
    },
    "hd_pool": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Hd Pool"
    },
    "types": {
      "default": [],
      "items": {
        "$ref": "#/$defs/TurningTypeOutcome"
      },
      "title": "Types",
      "type": "array"
    },
    "affected_ids": {
      "default": [],
      "items": {
        "type": "string"
      },
      "title": "Affected Ids",
      "type": "array"
    }
  },
  "required": [
    "code",
    "caster_id",
    "roll"
  ],
  "title": "UndeadTurnedEvent",
  "type": "object"
}