capture_pie_screenshot
Capture a PNG of the Unreal Engine game or active editor viewport while omitting the UMG/Slate HUD. Optionally include a cropped HUD during Play-In-Editor that overwrites the image a frame later.
Instructions
Write a PNG of the game viewport (else the active editor viewport) from a synchronous ReadPixels, which omits the UMG/Slate HUD; returns output_path, width, height and bytes_written. With include_ui=true during PIE, a cropped HUD version overwrites output_path a frame later (ui_overwrite_next_frame).
Returns: { saved_to_pie_active, output_path, width, height, bytes_written, includes_ui, ui_overwrite_next_frame, ui_note? }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| include_ui | No | When true and PIE is running with rendering, also request an engine screenshot with the HUD that a later frame crops to the game viewport (editor chrome removed) and writes over output_path; SDR only, given up after 8 s. Default false. | |
| output_path | No | Optional string. If empty, auto-names into <Project>/Saved/MCP/PIE_<utc>.png. |