Scene image
get-scene-imageCapture a scene as an image with numbered token markers, grid, and metadata, so you can inspect the map and token positions.
Instructions
Take a picture of a scene so you can look at the map. Returns one image and, as JSON, every token with its number on the picture, name, grid cell, canvas position, size, disposition and hidden flag, plus the grid (type, cell size, distance) and how canvas pixels map to picture pixels. Grid labels on the picture count cells from 0 at the top left of the scene, the same numbers as the token list. When the GM views the scene, the rendered canvas is captured (background, tiles, drawings, token art; no lighting, fog or vision). Otherwise, or with mode "composed", the picture is the background with grid and numbered token markers. Read only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| grid | No | Draw grid lines (square grids). | |
| mode | No | auto: capture the canvas when the GM views this scene, otherwise compose. canvas: only a capture, an error when the scene is not on the canvas. composed: always background plus markers. | auto |
| format | No | jpeg (every client) or webp (smaller). | jpeg |
| region | No | Only this part of the scene, in grid cells counted from 0 at the top left. | |
| maxBytes | No | Largest encoded size in bytes, 50000 to 3750000. Quality is lowered first, then the size. | |
| gridLabels | No | Write column numbers along the top and row numbers along the left edge. | |
| maxDimension | No | Long edge of the picture in pixels, 256 to 4096. Never enlarged beyond the scene. | |
| tokenMarkers | No | Draw the token numbers of the list on the picture, coloured by disposition. | |
| sceneIdentifier | No | Scene by id or name. Without it the scene that is active for everyone. |