PlayRealmRuntimeConfig

Defined in: runtime/playRealmRuntime.ts:37

Properties

achievements?

optional achievements?: string[]

Defined in: runtime/playRealmRuntime.ts:92

The project’s declared achievement ids — Play checks an unlock against the same set a shipped build does, so a typo is found here.

---

app

app: App

Defined in: runtime/playRealmRuntime.ts:38

---

assetBaseUrl?

optional assetBaseUrl?: string

Defined in: runtime/playRealmRuntime.ts:77

Project-root URL for path-addressed runtime assets. Textures resolve through the uuid manifest, but the audio channel takes plain project-relative paths (audio.playSFX('assets/…')), so it needs this base to fetch from the project rather than the play-realm subdir.

---

assetManifest

assetManifest: Record<string, string>

Defined in: runtime/playRealmRuntime.ts:50

Lowercased uuid → fetchable URL (e.g. estella://project/<path>).

---

assetPathMap?

optional assetPathMap?: Record<string, string>

Defined in: runtime/playRealmRuntime.ts:58

Logical (source) path → fetchable staged path, for cooked builds whose content-addressed staging renamed the physical files. Path-style refs (a scene’s “assets/x.esmaterial”) resolve through this BEFORE extension sniffing, exactly like uuid refs — so a .png staged as .ktx2 transcodes. Omit when files are served at their logical paths (the editor realm).

---

audioConfig?

optional audioConfig?: AudioProjectConfig

Defined in: runtime/playRealmRuntime.ts:89

Project-declared mixer state (bus volumes / effects / duck rules).

---

canvas

canvas: HTMLCanvasElement

Defined in: runtime/playRealmRuntime.ts:40

---

catalogData?

optional catalogData?: CatalogData | null

Defined in: runtime/playRealmRuntime.ts:64

Logical path → build-path catalog for the same cooked case: loaders fetch their INNER text refs (a material’s shader) through Catalog.getBuildPath, which is identity without this. Omit alongside assetPathMap.

---

enableStats?

optional enableStats?: boolean

Defined in: runtime/playRealmRuntime.ts:94

Turn on per-phase / per-system frame timing (editor profiler; off in shipped games).

---

entrySceneName?

optional entrySceneName?: string

Defined in: runtime/playRealmRuntime.ts:48

SceneManager name of the entry sceneData (default ‘__play’). Shipped builds pass the real scene name so game code can switch back to it.

---

extraScenes?

optional extraScenes?: object[]

Defined in: runtime/playRealmRuntime.ts:45

Additional switchable scenes beyond the entry (SceneManager targets). path entries load lazily through the runtime Assets on first switch.

data?

optional data?: SceneData

name

name: string

path?

optional path?: string

---

manifest?

optional manifest?: AddressableManifest | null

Defined in: runtime/playRealmRuntime.ts:65

---

module

module: ESEngineModule

Defined in: runtime/playRealmRuntime.ts:39

---

persistUpdateKey?

optional persistUpdateKey?: string

Defined in: runtime/playRealmRuntime.ts:69

Storage key an applied hot-update persists under; boot restores it if present.

---

physicsConfig?

optional physicsConfig?: Physics2DPluginConfig

Defined in: runtime/playRealmRuntime.ts:83

Project-declared physics world config (gravity, solver tuning, collision-layer masks, sleep/continuous) from the editor’s Project Settings.

---

physicsEnabled?

optional physicsEnabled?: boolean

Defined in: runtime/playRealmRuntime.ts:80

Project-declared physics enable (.uproject features analog) — installs physics even for runtime-spawned bodies the static scene doesn’t show.

---

remoteRoot?

optional remoteRoot?: string

Defined in: runtime/playRealmRuntime.ts:67

CDN root remote-group assets resolve against — turns on hot-update delivery.

---

sceneData

sceneData: SceneData

Defined in: runtime/playRealmRuntime.ts:42

The current scene as RAW (@uuid:) SceneData — handles are realm-local.

---

uiTheme?

optional uiTheme?: "dark" | "light"

Defined in: runtime/playRealmRuntime.ts:85

Project-declared UI theme; ‘light’ re-skins ThemeStyle-tagged widgets at boot.

---

uiThemeOverrides?

optional uiThemeOverrides?: ThemeOverrides

Defined in: runtime/playRealmRuntime.ts:87

Project-declared theme token overrides (partial re-skin over the base).

---

wasmBaseUrl?

optional wasmBaseUrl?: string

Defined in: runtime/playRealmRuntime.ts:72

Base URL the engine side-modules (physics.wasm, …) are served from — same dir as esengine.wasm. When set, the realm can load physics on demand.