RecordNote

Referee: record an annotation in the logs, with no state effect at all.

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 state effect at all.\n\nThe note lands as a referee-visibility event and touches nothing: it is the\nmechanism for machine-issued records \u2014 a consequence that was dropped, a\ncascade that was cut short \u2014 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`][osrlib.crawl.events.NoteRecordedEvent] with the text.",
  "properties": {
    "command_type": {
      "const": "record_note",
      "default": "record_note",
      "title": "Command Type",
      "type": "string"
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source"
    },
    "text": {
      "minLength": 1,
      "title": "Text",
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "title": "RecordNote",
  "type": "object"
}