Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

sprite

Places a free prop (image, rect, or polygon) on a stage layer. JSON / Mode B only (no script sugar).

{
  "type": "sprite",
  "id": "chair",
  "value": "chair",
  "layer": "bg_front",
  "x": 625,
  "y": 494
}

Usually you need

FieldTypeDefaultEffect
idstring—Named sprite
valuestring or null—Asset name; null hides
layer"bg_front" | "fg" | "overlay""overlay"Draw band
x / ynumber—Position

All fields

FieldTypeDefaultEffect
idstring—Named id
layerenum"overlay"Plane band
kind"image" | "rect" | "polygon" | "model""image"Shape (model is in development)
valuestring or null—Asset / hide
x / y / width / height / ordernumber—Geometry
offsetnumber or array—Additive px
rotation_degreesnumber—Angle
color / corner_radius / points…—Primitives
opacity0–11.0Alpha
modulate / scalecolor / number or [sx,sy]—Tint / scale
transition / transition_in / transition_outkind"instant"Show/hide
transition_duration / durationnumber ≥ 00 (fade often 0.5 in comments)Seconds
sfxstring—Loop until hide
shaderobject or null—Shader; uniforms go in the object’s params (a top-level shader_params is not a sprite field)
bind / interaction / state_visual / layoutobject—Live / hooks / states / host
clearlayer name or "all"—Clear sprites
whenexpression—Skip when falsy

Sprites and objects · Planes · Binds.