NoteRecordedEvent
A referee note was recorded, and no game state changed.
Full documentation: NoteRecordedEvent. Wire type: note_recorded.
Default visibility: referee
Message codes: session.note.recorded
JSON Schema
{
"$defs": {
"Visibility": {
"description": "Who may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\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 referee note was recorded, and no game state changed.\n\nEmitted by `RecordNote`. The\n`Interpreter` uses it to leave a\nmachine-written note in the log when a consequence can't be applied, and referees\nuse it for their margin notes.",
"properties": {
"code": {
"default": "session.note.recorded",
"title": "Code",
"type": "string",
"description": "The message code, always `session.note.recorded`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "referee",
"description": "Referee visibility: a note is for the person running the game."
},
"event_type": {
"const": "note_recorded",
"default": "note_recorded",
"title": "Event Type",
"type": "string",
"description": "The event type, `note_recorded`, which identifies this class in serialized form."
},
"text": {
"title": "Text",
"type": "string",
"description": "The note as it was written."
}
},
"required": [
"text"
],
"title": "NoteRecordedEvent",
"type": "object"
}