FlagSetEvent

A session flag was written.

Full documentation: FlagSetEvent. Wire type: flag_set.

Default visibility: referee

Message codes: session.flag.set

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who is allowed to see an event.\n\nEvery event has one of these two values, and the split exists because B/X keeps some rolls behind the\nreferee's screen. Filter a log on it before you show anything to a player, or call\n`GameSession.view`, which builds the player's and the referee's\nviews for you. A narrator playing referee reads both.\n\nThe values are the lowercase strings and they serialize into every event, so a renamed value is a\n`schema_version` bump.\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 session flag was written.\n\nEmitted by the referee's `SetFlag`. Flags are\nthe game's own memory: an adventure's triggers and gates read them through a\n`FlagEqualsCondition`, and a game can\nkeep whatever else it wants there.\n\nIt's referee visibility, because what the game is keeping track of isn't part\nof the fiction the party is in.",
  "properties": {
    "code": {
      "default": "session.flag.set",
      "title": "Code",
      "type": "string",
      "description": "The message code, always `session.flag.set`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee",
      "description": "Referee visibility: the wiring behind the game stays behind the screen."
    },
    "event_type": {
      "const": "flag_set",
      "default": "flag_set",
      "title": "Event Type",
      "type": "string",
      "description": "The wire discriminator, `flag_set`."
    },
    "key": {
      "title": "Key",
      "type": "string",
      "description": "Which flag was written."
    },
    "value": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "boolean"
        }
      ],
      "title": "Value",
      "description": "What it was set to. Writing an existing key replaces its value."
    }
  },
  "required": [
    "key",
    "value"
  ],
  "title": "FlagSetEvent",
  "type": "object"
}