API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceUnloadOptions

@codexo/exojs / core / stable

Options passed to SceneDirector.unload.

2
props
0
methods
0
events
Import
import { UnloadOptions } from '@codexo/exojs'

Options passed to SceneDirector.unload.

Properties2
instance?: "all" | SceneInstanceKindWhich kind of scene activation a disambiguating SceneDirector.unload call targets.
Disambiguates which candidate to discard when more than one exists for the same constructor (active, retained, and/or preloaded can all coexist). Omit only when exactly one candidate exists - 'all' discards every one that does.
transition?: SceneTransitionSelectionThe full set of values accepted for a `transition` option - call-site (`change()`/`restore()`/`unload()`) or registry-level default: a single SceneTransition (…
Only materializes for an active-scope match - a retained or preloaded match has nothing visible on screen to transition, and always runs the direct (non-transitioned) teardown path regardless of this option. A SceneTransitionSelection - unlike change()/restore(), unload() never consults a target's registry-level default transition; this option is the only source of a transition here.
Source
src/core/scene/sceneTypes.ts