App

Defined in: app.ts:71

Accessors

isPhysicsReady

Get Signature

get isPhysicsReady(): boolean

Defined in: app.ts:436

Returns

boolean

---

pipeline

Get Signature

get pipeline(): RenderPipeline | null

Defined in: app.ts:411

Returns

RenderPipeline | null

---

sideModules

Get Signature

get sideModules(): SideModuleHost | null

Defined in: app.ts:158

The realm’s optional-native-module acquirer (physics, spine). Physics and spine pull their wasm from here, so a realm wires its transport once (fetch / inlined / WeChat) and every subsystem follows.

Returns

SideModuleHost | null

---

spineInitPromise

Get Signature

get spineInitPromise(): Promise<unknown> | undefined

Defined in: app.ts:419

Returns

Promise<unknown> | undefined

Set Signature

set spineInitPromise(p): void

Defined in: app.ts:423

Parameters

p

Promise<unknown> | undefined

Returns

void

---

subsystems

Get Signature

get subsystems(): SubsystemRegistry

Defined in: app.ts:151

Subsystem lifecycle registry (“which modules loaded/ready/stepping/errored”). Named plugins auto-register in addPlugin; async plugins (physics) drive their own initializing→ready/error transitions.

Returns

SubsystemRegistry

---

wasmModule

Get Signature

get wasmModule(): ESEngineModule | null

Defined in: app.ts:407

Returns

ESEngineModule | null

---

world

Get Signature

get world(): World

Defined in: app.ts:445

Returns

World

Methods

addEvent()

addEvent<T>(event): this

Defined in: app.ts:228

Type Parameters

T

T

Parameters

event

EventDef<T>

Returns

this

---

addPlugin()

addPlugin(plugin): this

Defined in: app.ts:174

Parameters

plugin

Plugin

Returns

this

---

addPlugins()

addPlugins(plugins): this

Defined in: app.ts:166

Parameters

plugins

Plugin[]

Returns

this

---

addStartupSystem()

addStartupSystem(system): this

Defined in: app.ts:266

Parameters

system

SystemDef

Returns

this

---

addSystem()

addSystem(system): this

Defined in: app.ts:262

Parameters

system

SystemDef

Returns

this

---

addSystemSet()

addSystemSet(set): this

Defined in: app.ts:367

Shortcut for addSystemSetToSchedule(Schedule.Update, set).

Parameters

set

SystemSet

Returns

this

---

addSystemSetToSchedule()

addSystemSetToSchedule(schedule, set): this

Defined in: app.ts:330

Register every system in set onto schedule. Each member inherits the set’s runIf (AND-combined with its own if supplied per-system here), and its runBefore / runAfter lists are prepended to the member’s edges. Other systems may reference the set’s name in their own ordering; the scheduler expands those references to every member.

Parameters

schedule

Schedule

set

SystemSet

Returns

this

---

addSystemToSchedule()

addSystemToSchedule(schedule, system, options?): this

Defined in: app.ts:237

Parameters

schedule

Schedule

system

SystemDef

options?

runAfter?

string[]

runBefore?

string[]

runIf?

RunCondition

Returns

this

---

connectCpp()

connectCpp(cppRegistry, module?, options?): this

Defined in: app.ts:393

Parameters

cppRegistry

CppRegistry

module?

ESEngineModule

options?

BridgeConnectOptions

Returns

this

---

enableStats()

enableStats(): this

Defined in: app.ts:520

Returns

this

---

getEntityCount()

getEntityCount(): number

Defined in: app.ts:562

Returns

number

---

getFixedTimestep()

getFixedTimestep(): number

Defined in: app.ts:459

The fixed-update timestep (seconds) — the FixedUpdate / physics cadence.

Returns

number

---

getFrameScopes()

getFrameScopes(): ReadonlyMap<string, number> | null

Defined in: app.ts:542

Sub-frame CPU scopes recorded this frame via measureFrameScope — the finer breakdown within a single system, keyed by scope name. Null when stats aren’t enabled. Sibling of getSystemTimings / getPhaseTimings; surfaces as the profiler’s js.* rows.

Returns

ReadonlyMap<string, number> | null

---

getPhaseTimings()

getPhaseTimings(): ReadonlyMap<string, number> | null

Defined in: app.ts:532

Returns

ReadonlyMap<string, number> | null

---

getPlaySpeed()

getPlaySpeed(): number

Defined in: app.ts:512

Returns

number

---

getPlugin()

getPlugin<T>(ctor): T | undefined

Defined in: app.ts:144

Type Parameters

T

T extends Plugin

Parameters

ctor

(…args) => T

Returns

T | undefined

---

getRegisteredResourceNames()

getRegisteredResourceNames(): string[]

Defined in: app.ts:593

Returns

string[]

---

getResource()

getResource<T>(resource): T

Defined in: app.ts:575

Type Parameters

T

T

Parameters

resource

ResourceDef<T>

Returns

T

---

getResourceByName()

getResourceByName(name): unknown

Defined in: app.ts:583

Parameters

name

string

Returns

unknown

---

getResourceChangeTick()

getResourceChangeTick(name): number

Defined in: app.ts:588

Parameters

name

string

Returns

number

---

getSystemTimings()

getSystemTimings(): ReadonlyMap<string, number> | null

Defined in: app.ts:528

Returns

ReadonlyMap<string, number> | null

---

getTargetFrameRate()

getTargetFrameRate(): number

Defined in: app.ts:508

Returns

number

---

hasResource()

hasResource<T>(resource): boolean

Defined in: app.ts:579

Type Parameters

T

T

Parameters

resource

ResourceDef<T>

Returns

boolean

---

hotSwapSystems()

hotSwapSystems(incoming): boolean

Defined in: app.ts:283

Hot-swap the project’s (user-authored) system function bodies in place, keeping the live World/Registry/entities — the state-preserving hot-reload fast path (RC10 P3). incoming is the freshly re-imported bundle’s drained systems.

Returns false when the structure changed — a user system was added, removed, or renamed, or a schedule’s user-system count differs — because the running systems then no longer line up with the new code, so the caller must full-reload instead. Builtin/plugin systems (those with an owning subsystem) are never touched. The match validates fully before mutating, so a rejected swap leaves the scheduler untouched (no torn half-swap). Component identity is stable by name (see component.ts), so the new functions’ queries resolve to the live storage.

Parameters

incoming

readonly object[]

Returns

boolean

---

insertResource()

insertResource<T>(resource, value): this

Defined in: app.ts:570

Type Parameters

T

T

Parameters

resource

ResourceDef<T>

value

T

Returns

this

---

isPaused()

isPaused(): boolean

Defined in: app.ts:492

Returns

boolean

---

measureFrameScope()

measureFrameScope<T>(name, fn): T

Defined in: app.ts:551

Time fn as a named sub-frame scope (accumulated if the name repeats in a frame). A no-op passthrough when stats are off, so shipped games pay only a single branch. Use it to split a heavy system into attributable pieces.

Type Parameters

T

T

Parameters

name

string

fn

() => T

Returns

T

---

onError()

onError(handler): this

Defined in: app.ts:473

Parameters

handler

(error, systemName) => void

Returns

this

---

onSystemError()

onSystemError(handler): this

Defined in: app.ts:478

Parameters

handler

(error, systemName?) => "pause" | "continue"

Returns

this

---

onWasmError()

onWasmError(handler): this

Defined in: app.ts:483

Parameters

handler

(error, context) => void

Returns

this

---

quit()

quit(options?): void

Defined in: app.ts:677

Parameters

options?

keepRenderer?

boolean

Returns

void

---

registerScene()

registerScene(config): this

Defined in: app.ts:601

Parameters

config

SceneConfig

Returns

this

---

removeSystem()

removeSystem(systemId): boolean

Defined in: app.ts:371

Parameters

systemId

symbol

Returns

boolean

---

run()

run(): Promise<void>

Defined in: app.ts:631

Returns

Promise<void>

---

setFixedTimestep()

setFixedTimestep(timestep): this

Defined in: app.ts:453

Parameters

timestep

number

Returns

this

---

setInitialScene()

setInitialScene(name): this

Defined in: app.ts:606

Parameters

name

string

Returns

this

---

setMaxDeltaTime()

setMaxDeltaTime(v): this

Defined in: app.ts:463

Parameters

v

number

Returns

this

---

setMaxFixedSteps()

setMaxFixedSteps(v): this

Defined in: app.ts:468

Parameters

v

number

Returns

this

---

setPaused()

setPaused(paused): void

Defined in: app.ts:488

Parameters

paused

boolean

Returns

void

---

setPipeline()

setPipeline(pipeline): void

Defined in: app.ts:415

Parameters

pipeline

RenderPipeline

Returns

void

---

setPlaySpeed()

setPlaySpeed(speed): void

Defined in: app.ts:500

Parameters

speed

number

Returns

void

---

setSideModules()

setSideModules(host): void

Defined in: app.ts:162

Parameters

host

SideModuleHost

Returns

void

---

setTargetFrameRate()

setTargetFrameRate(fps): void

Defined in: app.ts:504

Parameters

fps

number

Returns

void

---

stepFrame()

stepFrame(): void

Defined in: app.ts:496

Returns

void

---

tick()

tick(delta): Promise<void>

Defined in: app.ts:615

Parameters

delta

number

Returns

Promise<void>

---

waitForPhysics()

waitForPhysics(): Promise<void>

Defined in: app.ts:427

Returns

Promise<void>

---

new()

static new(): App

Defined in: app.ts:136

Returns

App