Skip to content

SavingThrowRolledEvent

A saving throw and how it went.

Full documentation: SavingThrowRolledEvent. Wire type: saving_throw_rolled.

Default visibility: player

Message codes: combat.save.auto, combat.save.failed, combat.save.passed

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\n\nExamples:\n    ```python\n    from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n    log = [\n        DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n        HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n    ]\n    shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n    assert shown == [\"combat.damage.dealt\"]  # the goblin's remaining hit points stay hidden\n    ```",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "A saving throw and how it went.\n\n`saving_throw` reports one of these whenever a creature gets a chance to\navoid something. What passing or failing means depends on what forced the save, so read this event with the\nevents after it.\n\nA monster whose defenses give it an automatic save against a magical effect's element, as a red dragon has\nagainst magical fire, rolls nothing. Then `roll` and `required` are `None`.",
  "properties": {
    "code": {
      "title": "Code",
      "type": "string",
      "description": "What happened, like `combat.attack.hit`: two or more lowercase parts separated by dots. The first part is\nthe area of the rules the event comes from, like `combat` or `magic`.\n\nBranch on it, and pass the event to `format_message` to turn it into English.\nBuilding an event with a code in any other format raises a pydantic `ValidationError`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player",
      "description": "Player visibility: saving throws are rolled in the open, monsters included."
    },
    "event_type": {
      "const": "saving_throw_rolled",
      "default": "saving_throw_rolled",
      "title": "Event Type",
      "type": "string",
      "description": "The fixed string that identifies this event class in a serialized event."
    },
    "target_id": {
      "title": "Target Id",
      "type": "string",
      "description": "The entity id of the creature that saved."
    },
    "category": {
      "title": "Category",
      "type": "string",
      "description": "Which saving throw it was, as a `SaveCategory` value: `death`, `wands`,\n`paralysis`, `breath`, or `spells`."
    },
    "roll": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Roll",
      "description": "The d20 as it landed, before modifiers. `None` on an automatic save."
    },
    "modifier": {
      "default": 0,
      "title": "Modifier",
      "type": "integer",
      "description": "The sum of everything added to the roll, like a spell, a ring, and your adjustment."
    },
    "required": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Required",
      "description": "The number the roll plus the modifier had to reach. `None` on an automatic save."
    }
  },
  "required": [
    "code",
    "target_id",
    "category"
  ],
  "title": "SavingThrowRolledEvent",
  "type": "object"
}