export_parallax
Export a parallax background's layers with the files an engine scrolls them by, and return a
download link to the zip.
A deterministic file operation: no model runs and no Creative Units are spent. The file must be a
parallax split's output (one run with `parallax` set), which records each layer's scroll speed and whether
the layers loop. Layers generated one image at a time are not a parallax split: they go to the engine
as the images they are, and this tool refuses them. Every
layer is written at the background's full size, farthest first, so placed at one point they line up.
The zip holds a README with the engine's import steps.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
file_idrequired | string (uuid) | — | The parallax background: the workspace file id of a layered file made by a parallax split (a run with `parallax` set), which records each layer's scroll speed. |
enginerequired | enum | — | GODOT: each layer as an image and a Parallax2D scene (.tscn) that scrolls them, for Godot 4.3 or later. UNITY: each layer as a sprite with its .meta, and parallax.json with the scroll factors. JSON: each layer as an image and parallax.json, for any engine. One of: GODOT, UNITY, JSON |
name | string0–120 chars | — | Name of the background: the zip's folder and the files in it. |
workspace_idrequired | string (uuid) | — | The user's workspace id. |