Skip to content

ExtinguishSource

Put out every torch and lantern one member has burning (takes no game time).

Full documentation: ExtinguishSource. Wire type: extinguish_source.

Legal session modes: exploring, town

JSON Schema

{
  "description": "Put out every torch and lantern one member has burning (takes no game time).\n\nIt's legal in town and while exploring. The remaining burn time is lost. A doused torch\nis gone, and a doused lantern's oil is gone too, so lighting it again with\n`LightSource` burns a new flask. A light from a\nspell or a magic sword isn't affected.\n\nModes:\n    `town`, `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - an encounter or battle is underway, or the\n      session has ended.\n    - `session.command.unknown_member` - `character_id` matches no party member.\n    - `session.command.member_incapacitated` - the member can't act.\n    - `exploration.light.not_burning` - the member has no torch or lantern burning.\n\nEvents:\n    For each doused source, an\n    `EffectReleasedEvent` and a\n    `LightEvent` with code\n    `exploration.light.extinguished`.",
  "properties": {
    "command_type": {
      "const": "extinguish_source",
      "default": "extinguish_source",
      "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."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The member whose light goes out, by\n`MemberView.id`. Every torch and lantern this member has\nburning goes out, and the remaining burn time is lost rather than saved for later."
    }
  },
  "required": [
    "character_id"
  ],
  "title": "ExtinguishSource",
  "type": "object"
}