inspect_view
Render a custom large view of a hull or vehicle from any angle to inspect details hidden by fixed previews; returns image with caption and optional highlight position and metre rulers.
Instructions
Render one large view of a hull design or saved vehicle from any angle, like a camera you can point, to check details the fixed previews hide. Returns the image and a caption; with highlight, the box's position in spec units and as game-metre heights above the keel. Views at pitch 0 or +-90 get metre rulers in spec units (z from the transom, y from the keel, x from the centreline). Use preview_hull for the standard set of views. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| yaw | No | Camera heading in degrees: 0 = side with bow right, 90 = bow, 180 = other side, 270 = stern. | |
| name | No | Saved vehicle to view; omit to build spec/preset/design instead. | |
| spec | No | Hull spec, partial or full (fields: hull_design_guide topic=spec); merged over preset or design. Lengths in metres. | |
| zoom | No | 1 = whole vehicle, 2-6 = close-up. | |
| focus | No | [fx, fy, fz] fractions of the bounding box to centre on (x across, y up, z stern to bow), e.g. [0.5, 0.3, 0.9] = low on the bow. | |
| patch | No | JSON-Patch ops applied last, e.g. [{"op": "replace", "path": "/superstructure/bridge/height", "value": 2.5}]; list items can be named instead of indexed. | |
| pitch | No | Camera degrees above (+) or below (-) the horizon; -30 shows the bottom. | |
| design | No | Stored design to start from instead of a preset; names from list_designs. | |
| preset | No | Built-in hull preset to start from, e.g. 'runabout'; names from list_hull_presets. | |
| source | No | "vehicles" (default) reads the player's vehicles folder; "workshop" reads an installed Workshop item by numeric ID. | vehicles |
| body_id | No | unique_id of one body of a multi-body vehicle; default is the largest body. Saved vehicles only. | |
| renderer | No | "auto" (default) lights the scene like the game, on the GPU when available; "gpu"/"cpu" force one; "flat" is fastest and unlit, with block outlines for counting blocks. | |
| highlight | No | Superstructure box name to paint magenta, label and report the position of (designs only). | |
| spec_path | No | Path to a .json file holding a spec or a stored design, read before spec and patch. |