Stage
Interface contract, see /zero/source/design/spec.md.
Stage
Interface contract, see /zero/source/design/spec.md.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2strict
rays(ox: number, oy: number, dir: number, spread: number, col: { number }, strength: number, flicker: number) → void
| arg | type | description |
|---|---|---|
| ox | number | |
| oy | number | |
| dir | number | |
| spread | number | |
| col | { number } | |
| strength | number | |
| flicker | number |
placesWithGarnish( ) → void
fxCard(material: string, z: number, life: number, x: number?, y: number?) → void
| arg | type | description |
|---|---|---|
| material | string | |
| z | number | |
| life | number | |
| x | number? | |
| y | number? |
setBackground(id: string, opts: { transition: string?, dur: number?, mood: string?, weather: string? }?) → void
Swap the background. opts.transition: any vnStage transition ("fade" default, "cut", "glitch", "crossfade", "ink", ...). The place's mood and weather come along.
| arg | type | description |
|---|---|---|
| id | string | |
| opts | { transition: string?, dur: number?, mood: string?, weather: string? }? |
show(castId: string, slot: string, expression: string?, opts: { enter: string?, flip: boolean?, pose: string?, dur: number? }?) → void
Show a cast member. opts.enter: any vnStage entrance ("fade", "slide", "drop", "pop", ...); opts.flip; opts.pose ("a" | "b"). On stage already: moves / re-expresses / re-poses in place with a crossfade.
| arg | type | description |
|---|---|---|
| castId | string | |
| slot | string | |
| expression | string? | |
| opts | { enter: string?, flip: boolean?, pose: string?, dur: number? }? |
hide(castId: string, opts: { exit: string?, dur: number? }?) → void
opts.exit: any vnStage exit ("fade", "slide", "dissolve", "jump", ...).
| arg | type | description |
|---|---|---|
| castId | string | |
| opts | { exit: string?, dur: number? }? |
hideAll(opts: { exit: string? }?) → void
| arg | type | description |
|---|---|---|
| opts | { exit: string? }? |
expression(castId: string, expression: string) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| expression | string |
focus(castId: string?) → void
The speaker (nil = nobody); emphasis follows Stage.emphasis (default "dim").
| arg | type | description |
|---|---|---|
| castId | string? |
shake(strength: number?, duration: number?) → void
| arg | type | description |
|---|---|---|
| strength | number? | |
| duration | number? |
pushIn(amount: number?, duration: number?) → void
| arg | type | description |
|---|---|---|
| amount | number? | |
| duration | number? |
resetCamera(duration: number?) → void
| arg | type | description |
|---|---|---|
| duration | number? |
flash(color: string?, duration: number?) → void
color: "white" | "gold" | "cyan" | "red" | "rose" | "black" | "#rrggbb".
| arg | type | description |
|---|---|---|
| color | string? | |
| duration | number? |
whisperMode(on: boolean) → void
Whisper mode: the trance, world drains to indigo, Ren steps forward in his casting pose, code glyphs swirl around the target.
| arg | type | description |
|---|---|---|
| on | boolean |
fx(name: string) → void
One-shot effects: "gold_burst" | "glitch" | "level_up" | "rank_up" | "code_rain" | "victory", plus vnStage's "burst" "confetti" "rising" "sparkle".
| arg | type | description |
|---|---|---|
| name | string |
whisperTarget(puzzleId: string?, rect: { x: number, y: number, w: number, h: number }?) → void
Whisper target: the puzzle's item floats in the scene at a rectangle of the screen { x, y, w, h } (fractions, top-left origin). puzzleId nil removes it.
| arg | type | description |
|---|---|---|
| puzzleId | string? | |
| rect | { x: number, y: number, w: number, h: number }? |
ambient(preset: string?) → void
Ambient particles (legacy name). preset: a background id or the story's short names (dungeon guild forest arena city throne) = that place's weather; or dust glyphs sparks embers fireflies sand off; or any vnStage weather id.
| arg | type | description |
|---|---|---|
| preset | string? |
pose(castId: string, pose: string, expression: string?) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| pose | string | |
| expression | string? |
react(castId: string, kind: string) → void
hop bounce shake nod shiver lean_in sway startle sigh puff flinch glow
| arg | type | description |
|---|---|---|
| castId | string | |
| kind | string |
mood(id: string) → void
dawn morning day noon golden dusk night moonlit torchlit candle lanterns royal storm crimson sepia indigo
| arg | type | description |
|---|---|---|
| id | string |
weather(id: string) → void
vnStage weather id, "+"-combinable ("rain+fog"); "off" clears.
| arg | type | description |
|---|---|---|
| id | string |
transition(style: string?, dur: number?, midFn: (() → void
Any vnStage transition; midFn runs when the screen is covered.
| arg | type | description |
|---|---|---|
| style | string? | |
| dur | number? | |
| midFn | (( |
emphasis(mode: string) → void
dim (default) lift scale spotlight rim bob silhouette none
| arg | type | description |
|---|---|---|
| mode | string |
pan(target: any, duration: number?) → void
| arg | type | description |
|---|---|---|
| target | any | |
| duration | number? |
impact(style: string?, castId: string?, strength: number?) → void
| arg | type | description |
|---|---|---|
| style | string? | |
| castId | string? | |
| strength | number? |
snapshot( ) → void
restore(snap: { [string]: any }) → void
| arg | type | description |
|---|---|---|
| snap | { [string]: any } |
pictureOf(snap: { [string]: any }?) → void
| arg | type | description |
|---|---|---|
| snap | { [string]: any }? |
hasBackground(id: string) → boolean
Whether a place id has a painting the stage can show.
| arg | type | description |
|---|---|---|
| id | string |
lists( ) → void
state( ) → void
The stage's state, for inspection (nil outside play): { background, place, mood, weather, whisper (0..1), whisperOn, speaker, actors, cameraZ, ... }.
The visual-novel stage API (game.stage.Stage): backgrounds, character sprites in slots with expressions and focus, camera shake/push-in/flash, Software Whisper mode and particle FX, routed to the StageRig component.Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
Showing up to 3 levels deep. Open a part to see what it holds further down.
Problems
Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.
agent_score is exposed.+ quality × 0.35
+ performance × 0.25
± compat factor
Usability ratings
Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".
Scoped to this part · feeds back into the world's score.