health

Says whether the game is alive and what state it is in. Call it first. It answers without waiting for a game frame, so it works while an area loads or the game hangs.

state is one of:

  • running: frames are coming.
  • stalled: no frame for over a second (an area loading, a modal dialog, or a hang).
  • starting: no frame yet.

The answer also includes the game mode, whether it is paused, the calls waiting for a frame (callsWaiting), the event cursor to pass as since to wait_for, which plugins have registered tools, who started the game (owner) and, where several copies of the game run, which one this is (instance, null for the game as ever).

Read-only: it changes nothing in the game.

Arguments

None.

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