ExtinguishSource

Extinguish the bearer's burning source, forfeiting the remainder (zero time).

Full documentation: ExtinguishSource. Wire type: extinguish_source.

Legal session modes: exploring, town

JSON Schema

{
  "description": "Extinguish the bearer's burning source, forfeiting the remainder (zero time).\n\nLegal in town and while exploring. A doused torch or lantern is spent, and the\nremaining burn time does not bank.\n\nModes:\n    `town`, `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - an encounter or battle is underway, or the\n      game is over.\n    - `session.command.unknown_member` - `character_id` names no party member.\n    - `session.command.member_incapacitated` - the member cannot act.\n    - `exploration.light.not_burning` - the member carries no burning torch or\n      lantern.\n\nEvents:\n    An `EffectReleasedEvent` and a\n    `LightEvent` with code\n    `exploration.light.extinguished` per doused source.",
  "properties": {
    "command_type": {
      "const": "extinguish_source",
      "default": "extinguish_source",
      "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."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The bearer whose light goes out, by\n`MemberView.id`. Every burning source this member\ncarries is doused, and the remaining burn time is lost rather than banked."
    }
  },
  "required": [
    "character_id"
  ],
  "title": "ExtinguishSource",
  "type": "object"
}