Skip to content

RecordNote

Referee: write a note into the logs, with no effect on the game.

Full documentation: RecordNote. Wire type: record_note.

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

JSON Schema

{
  "description": "Referee: write a note into the logs, with no effect on the game.\n\nThe note becomes an event at referee visibility and changes nothing else. Use it for a\nrecord from your code, like an authored consequence that was dropped, or for a\nreferee's notes. The trigger and quest interpreter issues it to record what it dropped\nand why. This command is legal in every mode, `game_over` and `victory` 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 name that identifies the command class in serialized data. Each command class fixes\nit to a distinct snake_case string, like `\"move_party\"` or `\"open_door\"`, and constructing\nthe class sets it, so you never pass it yourself.\n`parse_command` and the\n`AnyCommand` union use it to rebuild the right class\nfrom a serialized mapping. A class's value never changes between releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "Who or what issued the command on whose behalf: an authored trigger or quest id, or the\nname of one of your game's systems. The engine never reads it, so a command with a\n`source` does exactly what the same command without one does. The session logs and\nreplays it with the command, so the log alone shows why something happened. Leave it\n`None` when there's nothing to record. An empty string fails validation when the command\nis constructed."
    },
    "text": {
      "minLength": 1,
      "title": "Text",
      "type": "string",
      "description": "The note to record. It goes into the log as an event at referee visibility and changes no\nstate. To give the players a line to read, issue an\n`AddJournalEntry` instead."
    }
  },
  "required": [
    "text"
  ],
  "title": "RecordNote",
  "type": "object"
}