creatures

Lists every creature in the area, nearest first. Each has its id, name, tag, template, position, distance, whether it is dead, its health and manaStamina, combatState, attackTarget, the command it is carrying out, and:

  • side: party, hostile or neutral, as seen by the creature you control (or the hero if none).
  • group: the game’s own faction number: 0 the player’s, 1 hostile, 2 friendly.
  • room: the room it stands in (number), whether the party has seen it (never, in view or before; a room never seen is drawn black, along with everything in it), whether it is shown, how much the game wants it (wanted: dropped, kept, now) and whether it is in memory (load). Null where the area has no rooms.

creature gives one creature in full detail.

Read-only: it changes nothing in the game.

Arguments

Name Type Required What
near string   Measure distances from this creature, by id. Default: the creature you control.
radius number   Only those within this many meters of near. Default: the whole area.
side "party" | "hostile" | "neutral"   Only creatures on this side. Default: all sides.
includeDead boolean   Include dead creatures. Default true.
includeInactive boolean   Also list creatures the area keeps hidden. Default false; then inactiveLeftOut says how many were left out.
brief boolean   Return one line per creature (lines: id, name, tag, side, health, dead, distance) instead of full detail. Default false.

Call it as creatures over MCP, or POST /api/tool/creatures with the arguments as JSON.