bg
Shows or clears the stage background image.
{ "type": "bg", "value": "street", "transition": "fade", "duration": 0.5 }
[bg street fade 0.5]
[bg clear]
Usually you need
| Field | Type | Default | Effect |
|---|---|---|---|
value | string or null | — | Image name under backgrounds/; null clears |
transition | transition kind | fade if omitted | Enter / leave |
duration | number ≥ 0 | 0.5 if omitted with default fade | Seconds |
All fields
| Field | Type | Default | Effect |
|---|---|---|---|
value | string or null | — | Image / clear |
transition / transition_in / transition_out | kind | omit → fade | Kinds: instant, fade, slide_* |
transition_duration / duration | number ≥ 0 | omit → 0.5 | Seconds |
opacity | number 0–1 | 1 when omitted on a show | Plate alpha baseline (binds compose on top) |
modulate | color string | white when omitted on a show | Tint baseline |
visible | bool | true when omitted on a show | Show/hide baseline |
shader | string or object or null | absent = keep; null = clear | Stem under shaders/, or an object with name / params / target / pass / margin — Effects |
shader_params | object | — | Uniforms when setting shader |
bind | object | — | image, opacity, modulate, visible, plus shader:… |
interaction | object | — | hooks.on_show / on_hide / on_change |
when | expression | — | Skip when falsy |
Bind notes
bind.imageuses the same stems asvalue(files underbackgrounds/). Swaps are instant — use an explicitbgcommand when you want a fade.- Bind look keys compose with the command baselines above (
opacity/modulate/visible). - While a model background or an active background pack is showing,
image/opacity/modulate/visiblebinds are ignored (shader:…still applies when a shader is set).
Clearing the image also clears shader and bind. Guide: Backgrounds, Transitions, Binds, Shaders.