vnStageRig
The live stage of vnStage. `vnStage.stage` adds it on first use (in play) to the scene's stage root entity (default name `Stage`) and pushes the configuration (cast, places, slots) into it; every stage call is a method here, so the stage keeps one state for every Luau environment…
vnStageRig
The live stage of vnStage. vnStage.stage adds it on first use (in play) to the scene's stage root entity (default name Stage) and pushes the configuration (cast, places, slots) into it; every stage call is a method here, so the stage keeps one state for every Luau environment. It hides the scene's own background plane and draws its own: two painted planes with pseudo-depth parallax (crossfade / slide-push partner), a 2.5D foreground card, actors with 18 entrances / 16 exits / 12 reactions / 8 emphasis modes and pose crossfades, weather cards, the transition / flash / spotlight overlay, a mood-driven grade (bloom + vnGrade), camera breathing, pan, push, shake and impact frames, props and one-shot FX, plus snapshot() / restore(). Everything it spawns is a local child of the root. Needs a camera entity (default StageCamera).
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2vnStage.vnStageRig, the live visual-novel stage. One instance sits on the scene's stage root entity (vnStage.stage adds it on first use, in play) and every stage call is a method on it, so the stage has exactly one state however many Luau environments call in. Everything it spawns is a local, unsynced child of the root: each player watches their own story. It owns: two background planes (painting + crossfade/push partner) with a pseudo-depth parallax, a 2.5D foreground card, actors (sprites) with entrance/exit/reaction/emphasis animation and pose crossfades, weather cards, the overlay card (flash, fade, spotlight, trance vignette and shader transitions), a PostProcess grade driven by the mood, camera beats, props, one-shot FX and snapshot/restore.
approach(v: number, t: number, rate: number, dt: number) → number
| arg | type | description |
|---|---|---|
| v | number | |
| t | number | |
| rate | number | |
| dt | number |
clamp01(x: number) → number return math
| arg | type | description |
|---|---|---|
| x | number |
lanes(e: any, i: number, x: number, y: number, z: number, w: number) → void
| arg | type | description |
|---|---|---|
| e | any | |
| i | number | |
| x | number | |
| y | number | |
| z | number | |
| w | number |
easeOutCubic(k: number) → number return 1
| arg | type | description |
|---|---|---|
| k | number |
easeInOut(k: number) → number
| arg | type | description |
|---|---|---|
| k | number |
easeOutBack(k: number) → number
| arg | type | description |
|---|---|---|
| k | number |
easeOutBounce(k: number) → number
| arg | type | description |
|---|---|---|
| k | number |
hexColor(h: string?) → void
| arg | type | description |
|---|---|---|
| h | string? |
c(i: number) → number
| arg | type | description |
|---|---|---|
| i | number |
lerp(a: number, b: number, k: number) → number return a
| arg | type | description |
|---|---|---|
| a | number | |
| b | number | |
| k | number |
quatMul(a: { number }, b: { number }) → void
| arg | type | description |
|---|---|---|
| a | { number } | |
| b | { number } |
frameH(z: number) → number return FRAME_K
| arg | type | description |
|---|---|---|
| z | number |
spawnPlane(name: string, material: any) → any
| arg | type | description |
|---|---|---|
| name | string | |
| material | any |
setMaterial(e: any, mat: any) → void
| arg | type | description |
|---|---|---|
| e | any | |
| mat | any |
despawn(e: any) → void
| arg | type | description |
|---|---|---|
| e | any |
despawnByPrefix(prefix: string) → void
| arg | type | description |
|---|---|---|
| prefix | string |
lookup(id: string?, kind: string) → any
Names come from the game's registries, so the configuring module resolves them (cfg.resolver); nothing here resolves a computed name.
| arg | type | description |
|---|---|---|
| id | string? | |
| kind | string |
texGuid(id: string?) → string
| arg | type | description |
|---|---|---|
| id | string? |
tryMaterial(id: string?) → any
| arg | type | description |
|---|---|---|
| id | string? |
runtimeMaterial(key: string, def: any) → any
| arg | type | description |
|---|---|---|
| key | string | |
| def | any |
fieldMaterial(layer: any) → any
| arg | type | description |
|---|---|---|
| layer | any |
castEntry(id: string) → any
| arg | type | description |
|---|---|---|
| id | string |
hasExpr(c: any, pose: string, expr: string) → boolean
| arg | type | description |
|---|---|---|
| c | any | |
| pose | string | |
| expr | string |
resolveArt(castId: string, pose: string?, expr: string?) → void
Resolve (pose, expr) to what the art has: alias, then neutral in the pose, then the default pose.
| arg | type | description |
|---|---|---|
| castId | string | |
| pose | string? | |
| expr | string? |
spriteMaterial(castId: string, pose: string, expr: string) → any
| arg | type | description |
|---|---|---|
| castId | string | |
| pose | string | |
| expr | string |
placeMaterial(id: string) → any
| arg | type | description |
|---|---|---|
| id | string |
moodDef(id: string) → void
| arg | type | description |
|---|---|---|
| id | string |
flatMood(m: any) → any
Flatten a mood into numbers so it can be blended.
| arg | type | description |
|---|---|---|
| m | any |
blendMood(dt: number, rate: number) → void
| arg | type | description |
|---|---|---|
| dt | number | |
| rate | number |
spawnCard(mat: any, z: number, x: number, y: number, kind: string, life: number?, s0: number?) → any
| arg | type | description |
|---|---|---|
| mat | any | |
| z | number | |
| x | number | |
| y | number | |
| kind | string | |
| life | number? | |
| s0 | number? |
fadeOutKind(kind: string) → void
| arg | type | description |
|---|---|---|
| kind | string |
weatherLayers(id: string) → void
| arg | type | description |
|---|---|---|
| id | string |
applyWeather(id: string, instant: boolean?) → void
| arg | type | description |
|---|---|---|
| id | string | |
| instant | boolean? |
findCamera( ) → any
awake( ) → void
build( ) → void
onDestroy( ) → void
off( ) → Off
styleOffset(style: string, k: number, side: number, a: any, entering: boolean) → Off
k: 0 = fully away, 1 = fully present. side: -1 left half, 1 right half.
| arg | type | description |
|---|---|---|
| style | string | |
| k | number | |
| side | number | |
| a | any | |
| entering | boolean |
env(t: number, up: number, hold: number, down: number) → number
| arg | type | description |
|---|---|---|
| t | number | |
| up | number | |
| hold | number | |
| down | number |
reactOffset(kind: string, t: number, side: number, o: Off) → void
| arg | type | description |
|---|---|---|
| kind | string | |
| t | number | |
| side | number | |
| o | Off |
emphasisTargets( ) → void
update(dt: number) → void
| arg | type | description |
|---|---|---|
| dt | number |
bgLanes(e: any, alphaT: number) → void
| arg | type | description |
|---|---|---|
| e | any | |
| alphaT | number |
syncActors( ) → void
configure(c: any, key: string) → void
| arg | type | description |
|---|---|---|
| c | any | |
| key | string |
setMoodNow(id: string, instant: boolean?) → void
| arg | type | description |
|---|---|---|
| id | string | |
| instant | boolean? |
swapPlace(id: string, instant: boolean?) → void
| arg | type | description |
|---|---|---|
| id | string | |
| instant | boolean? |
startCover(def: any, dur: number, mid: any) → void
| arg | type | description |
|---|---|---|
| def | any | |
| dur | number | |
| mid | any |
transition(style: string?, dur: number?, mid: any?) → void
| arg | type | description |
|---|---|---|
| style | string? | |
| dur | number? | |
| mid | any? |
runMid( ) → void
place(id: string, transition: string?, dur: number?) → void
| arg | type | description |
|---|---|---|
| id | string | |
| transition | string? | |
| dur | number? |
mood(id: string, instant: boolean?) → void
| arg | type | description |
|---|---|---|
| id | string | |
| instant | boolean? |
weather(id: string, instant: boolean?) → void
| arg | type | description |
|---|---|---|
| id | string | |
| instant | boolean? |
show(castId: string, slot: string, expr: string?, enter: string?, flip: boolean?, pose: string?, dur: number?) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| slot | string | |
| expr | string? | |
| enter | string? | |
| flip | boolean? | |
| pose | string? | |
| dur | number? |
hide(castId: string, exit: string?, dur: number?) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| exit | string? | |
| dur | number? |
hideAll(exit: string?) → void
| arg | type | description |
|---|---|---|
| exit | string? |
clearActors( ) → void
expression(castId: string, expr: string, pose: string?) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| expr | string | |
| pose | string? |
pose(castId: string, pose: string, expr: string?) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| pose | string | |
| expr | string? |
react(castId: string, kind: string) → void
| arg | type | description |
|---|---|---|
| castId | string | |
| kind | string |
focus(castId: string?) → void
| arg | type | description |
|---|---|---|
| castId | string? |
emphasis(mode: string) → void
| arg | type | description |
|---|---|---|
| mode | 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? |
pan(target: any, duration: number?) → void
| arg | type | description |
|---|---|---|
| target | any | |
| duration | number? |
resetCamera(duration: number?) → void
| arg | type | description |
|---|---|---|
| duration | number? |
flash(color: string?, duration: number?) → void
| arg | type | description |
|---|---|---|
| color | string? | |
| duration | number? |
impact(style: string?, castId: string?, strength: number?) → void
| arg | type | description |
|---|---|---|
| style | string? | |
| castId | string? | |
| strength | number? |
trance(on: boolean, opts: any?) → void
| arg | type | description |
|---|---|---|
| on | boolean | |
| opts | any? |
fx(name: string) → void
| arg | type | description |
|---|---|---|
| name | string |
prop(id: string, def: any?, placeId: string?) → void
prop(id, { material, glow?, x, y, z, w, h, glowW?, glowH?, bob?, hideInTrance?, tint? } | nil)
| arg | type | description |
|---|---|---|
| id | string | |
| def | any? | |
| placeId | string? |
snapshot( ) → any
restore(snap: any) → void
| arg | type | description |
|---|---|---|
| snap | any |
report( ) → any
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.