AddJournalEntry
Referee: add a line of story text to the session's journal.
Full documentation: AddJournalEntry. Wire type: add_journal_entry.
Legal session modes: battle, encounter, exploring, game_over, town, victory
JSON Schema
{
"description": "Referee: add a line of story text to the session's journal.\n\nThe journal is the party's record of the adventure, in the order the party discovered\nthings. Entries are only ever added: none is rewritten, and none is rebuilt from other\nstate, so an entry stays after whatever caused it is gone. Each entry is stamped with\nthe game clock's time when it's added, and\n`PlayerView.journal` returns the entries as they\nwere written. This command is legal in every mode, `game_over` and `victory` included, so you\ncan add a closing line after the adventure has ended.\n\nModes:\n `town`, `exploring`, `encounter`, `battle`, `game_over`, `victory`\n\nRejections:\n None.\n\nEvents:\n `JournalEntryAddedEvent` with\n the text and the clock time.",
"properties": {
"command_type": {
"const": "add_journal_entry",
"default": "add_journal_entry",
"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 line to add, as the players will read it. The session stamps it with the clock time,\nadds it to the end of the journal, and returns it unchanged in\n`PlayerView.journal`. Entries are never rewritten,\nso write the line you want kept."
}
},
"required": [
"text"
],
"title": "AddJournalEntry",
"type": "object"
}