SceneConfig
Defined in: scene/sceneManager.ts:48
A scene as registered: where its data comes from, the systems that run while it
is loaded, and hooks either side of its lifetime. path and data are
alternatives — a scene either loads from disk or is handed its content.
Properties
Section titled “Properties”cleanup?
Section titled “cleanup?”
optionalcleanup?: (ctx) =>void
Defined in: scene/sceneManager.ts:54
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
optionaldata?:SceneData
Defined in: scene/sceneManager.ts:51
discardPrepared?
Section titled “discardPrepared?”
optionaldiscardPrepared?: () =>number
Defined in: scene/sceneManager.ts:69
Throw away what prepare readied, answering how many receipts came back.
Returns
Section titled “Returns”number
externalEntities?
Section titled “externalEntities?”
optionalexternalEntities?: () =>ReadonlyMap<number,number>
Defined in: scene/sceneManager.ts:60
Authored ids this scene may reference in ANOTHER document, resolved at load time. A streamed cell names the persistent world through this; nothing else has a document boundary to cross.
Returns
Section titled “Returns”ReadonlyMap<number, number>
name:
string
Defined in: scene/sceneManager.ts:49
onPhase?
Section titled “onPhase?”
optionalonPhase?: (phase,ms) =>void
Defined in: scene/sceneManager.ts:62
Where this scene’s load spent its time. See SceneLoadOptions.onPhase.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”void
optionalpath?:string
Defined in: scene/sceneManager.ts:50
prepare?
Section titled “prepare?”
optionalprepare?: () =>Promise<void>
Defined in: scene/sceneManager.ts:67
Do everything this scene’s load can do without the world seeing anything —
fetch, decode, acquire. Creates no entities; load publishes what it left.
Returns
Section titled “Returns”Promise<void>
readyRenderPrograms?
Section titled “readyRenderPrograms?”
optionalreadyRenderPrograms?: () =>Promise<RenderReadiness>
Defined in: scene/sceneManager.ts:75
Ready the render programs this scene’s content requires, from what
prepare decoded. Absent means the obligation does not apply here, which
is how a headless host satisfies it — never by inventing a claim.
Returns
Section titled “Returns”Promise<RenderReadiness>
setup?
Section titled “setup?”
optionalsetup?: (ctx) =>void|Promise<void>
Defined in: scene/sceneManager.ts:53
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
systems?
Section titled “systems?”
optionalsystems?:object[]
Defined in: scene/sceneManager.ts:52
schedule
Section titled “schedule”schedule:
Schedule
system
Section titled “system”system:
SystemDef