Skip to content

MonstersLeftBehindEvent

A routing group left its helpless members where they lie.

Full documentation: MonstersLeftBehindEvent. Wire type: monsters_left_behind.

Default visibility: player

Message codes: battle.group.left_behind

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "A routing group left its helpless members where they lie.\n\nFleeing is movement, and a member who cannot move (asleep, paralysed, held by a\n*web*) cannot run: the runners split off and keep fleeing under the original\ngroup id while the helpless stay behind as the new group `group_id`, at the\ndistance the side broke from.",
  "properties": {
    "code": {
      "default": "battle.group.left_behind",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "monsters_left_behind",
      "default": "monsters_left_behind",
      "title": "Event Type",
      "type": "string"
    },
    "group_id": {
      "title": "Group Id",
      "type": "string"
    },
    "source_group_id": {
      "title": "Source Group Id",
      "type": "string"
    },
    "count": {
      "title": "Count",
      "type": "integer"
    }
  },
  "required": [
    "group_id",
    "source_group_id",
    "count"
  ],
  "title": "MonstersLeftBehindEvent",
  "type": "object"
}