TurnUndead
Present a holy symbol to turn undead monsters before a battle starts (one round).
Full documentation: TurnUndead. Wire type: turn_undead.
Legal session modes: encounter
JSON Schema
{
"description": "Present a holy symbol to turn undead monsters before a battle starts (one round).\n\nAn encounter must be open, because outside one there are no monsters to turn. In\nbattle, declare a `turn_undead`\n`BattleDeclaration` instead.\n\nThe turning reaches every living monster in the encounter's groups that haven't fled. It\nskips a monster that died earlier in the encounter, from a wand for example.\n\nA turned monster gains the `turned` condition. It flees from the cleric and attacks no one.\nA destroyed monster dies. The\n`UndeadTurnedEvent` reports the outcome, and a\nseparate condition or death event follows for each monster it affects.\n\nPresenting the symbol is an aggressive act. If any monster is left neither turned nor\ndestroyed, the monsters that weren't turned attack at once, and battle starts. In a group\nthat was only partly turned, the turned monsters split off as a new group and flee.\n\nModes:\n `encounter`\n\nRejections:\n - `session.command.wrong_mode` or `encounter.none_active` - no encounter is open.\n - `encounter.turning.mid_pursuit` - the monsters are pursuing the party, and\n nobody can turn undead during a pursuit.\n - `session.command.unknown_member` - `character_id` matches no party member.\n - `session.command.member_incapacitated` - the member can't act.\n - `magic.turning.not_a_turner` - the member's class can't turn undead.\n - `magic.turning.caster_incapacitated` - a condition on the member prevents\n the attempt.\n\nEvents:\n `UndeadTurnedEvent` with the roll\n and the affected monsters, with each condition it causes as a separate event.\n One round passes. When every monster is turned or destroyed, the encounter ends\n (`EncounterEndedEvent`), after a\n `LootDroppedEvent` when the destroyed\n undead leave anything on the floor. Otherwise a\n `StanceChangedEvent` to `attacks`\n comes before the round, and battle starts after it\n (`BattleStartedEvent`). A\n `MonsterFledEvent` follows for each new group\n of turned members.",
"properties": {
"command_type": {
"const": "turn_undead",
"default": "turn_undead",
"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 who presents the holy symbol, usually a cleric, by\n`MemberView.id`. The session refuses a member whose\nclass can't turn undead with `magic.turning.not_a_turner`."
}
},
"required": [
"character_id"
],
"title": "TurnUndead",
"type": "object"
}