placeables

Lists the doors, chests, levers and other placeables in the area, nearest first. Each has its id, name, tag, template, position and distance, and:

  • state, the placeable’s own state number (it changes when a door or chest opens), and stateName: shut, locked, open or destroyed.
  • action and actionName: what using it does now (loot, unlock, open, use, …).
  • active, interactive (whether it can be used) and popup, its tooltip text.
  • lock: whether it needs a key (keyRequired), the key’s tag (keyTag), whether the party has it (keyHeld), and the lock-picking level needed (pickLevel).
  • leadsTo, for a way out of the area: the destination area’s tag and waypoint.

Use one with order action=use.

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.
includeInactive boolean   Also list placeables the area keeps hidden. Default false; then inactiveLeftOut says how many were left out.
interactive boolean   true: only those that can be used; false: only those that cannot. Default: both.
brief boolean   Return one line per placeable (lines) instead of full detail. Default false.

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