RecordNote

Referee: record an annotation in the logs, with no effect on game state.

Full documentation: RecordNote. Wire type: record_note.

Legal session modes: battle, encounter, exploring, game_over, town, victory

JSON Schema

{
  "description": "Referee: record an annotation in the logs, with no effect on game state.\n\nThe note lands as a referee-visibility event and touches nothing. It is the\nmechanism for machine-issued records, like a consequence that was dropped or a\ncascade that was cut short, and for a referee's own margin notes alike.\nReferee commands are legal in every mode, terminal modes included.\n\nModes:\n    `town`, `exploring`, `encounter`, `battle`, `game_over`, `victory`\n\nRejections:\n    None.\n\nEvents:\n    `NoteRecordedEvent` with the text.",
  "properties": {
    "command_type": {
      "const": "record_note",
      "default": "record_note",
      "title": "Command Type",
      "type": "string",
      "description": "The wire discriminator. Each subclass fixes it to its own snake_case literal, like\n`\"move_party\"` or `\"open_door\"`, so you never set it yourself: constructing the subclass\ndoes. It's what `parse_command` and the\n`AnyCommand` union read to rebuild the right class\nfrom a serialized mapping, and it stays the same across releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "An annotation naming the authored object (a trigger or quest id) or the game\nsystem on whose behalf the command was issued. Execution never reads it: a stamped\ncommand does exactly what the same command unstamped does. It is logged and replayed\nwith the command, so the log alone answers \"why did this happen\". Absent is `None`,\nand the empty string is not a value."
    },
    "text": {
      "minLength": 1,
      "title": "Text",
      "type": "string",
      "description": "The annotation to record. It reaches the log as a referee-visibility event and changes no\nstate, which makes it the place for machine-issued records, like a consequence that was\ndropped, and for a referee's own margin notes. A line the players should read is an\n`AddJournalEntry` instead."
    }
  },
  "required": [
    "text"
  ],
  "title": "RecordNote",
  "type": "object"
}