screenshot
Capture an image of the running game or editor viewport to provide the agent with visual context, supporting UI annotation and region-specific inspection.
Instructions
Capture an image the agent can see. target=game (default) captures the RUNNING game; target=editor captures the 2D editor viewport (PNG only). A bare call caps the long edge at max_dim=1280 — pass scale, region, max_dim=0, format or save_to to opt out. annotate=ui draws numbered Set-of-Mark boxes and returns the legend. For pure functional state ui_snapshot is cheaper. Token dials + delivery: help(tool="screenshot").
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scale | No | 0.05..1.0 downscale before encode (game target; default 1.0) | |
| format | No | png (default) | jpeg | webp (game target) | |
| region | No | [x,y,w,h] pixel crop | |
| target | No | game | editor | |
| deliver | No | inline (default) | link (a capture:// resource_link, no base64) | both | |
| max_dim | No | cap the long edge in px (default 1280 on a call with no other framing argument; 0 = no cap) | |
| quality | No | jpeg/webp quality 0.1..1.0 (default 0.8) | |
| save_to | No | also write the frame to this path (res://, user:// or absolute); mints a diff baseline | |
| annotate | No | 'ui' = draw numbered marks on interactive controls + return the legend (game target) | |
| max_marks | No | cap on annotate marks (default 40) |