ui_snapshot
Captures running Godot game UI as structured Control data—paths, classes, text, rects, semantic states—so functional checks avoid screenshots and per-control reads.
Instructions
One-call UI snapshot of the RUNNING game: every visible Control as structured data (path, class, text, rect, and the semantic state pixels cannot tell you: disabled, focused, checked, value, selected, editable, tooltip) plus per-control honesty flags. For FUNCTIONAL UI checks this replaces a screenshot plus a read per control; keep screenshot for visual/render bugs. Every field, and the free since_hash re-read: help(tool="ui_snapshot").
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "ui_snapshot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | subtree root to scope the walk (name, relative, or /root/...) | |
| max_nodes | No | cap on emitted controls (default 150) | |
| occlusion | No | compute occluded_by for interactive controls (default true; one hit-test walk per interactive control) | |
| since_hash | No | hash from a previous call — unchanged UI returns {unchanged:true} instead of the payload | |
| interactive_only | No | only buttons/sliders/fields/lists/tabs + focusables (default false = all visible controls) |