Class: Engine

MMPX — backend-agnostic ECS for playable ads. Public surface only; files inside src/MMPX/ import each other by relative path (going through the barrel breaks tree-shaking and risks cycles). Flat re-exports for the names you reach for constantly.

Implements

• IEngine

Constructors

Constructor

new Engine(options): Engine;

Parameters

Parameter	Type
options	EngineOptions

Returns

Engine

Methods

GetActiveScene()

GetActiveScene(): Scene | null;

Returns

Scene | null

---

GetAdAdapter()

GetAdAdapter(): IAdAdapter;

Returns

IAdAdapter

Implementation of

IEngine.GetAdAdapter

---

GetAssetLoader()

GetAssetLoader(): IAssetLoader;

Returns

IAssetLoader

Implementation of

IEngine.GetAssetLoader

---

GetAudio()

GetAudio(): IAudio | null;

Returns

IAudio | null

Implementation of

IEngine.GetAudio

---

GetAvgFpsCount()

GetAvgFpsCount(): number;

Returns

number

Implementation of

IEngine.GetAvgFpsCount

---

GetAvgTpsCount()

GetAvgTpsCount(): number;

Returns

number

Implementation of

IEngine.GetAvgTpsCount

---

GetBackend()

GetBackend(): IBackend;

Returns

IBackend

---

GetBuildInfo()

GetBuildInfo(): Readonly<BuildInfo>;

Returns

Readonly<BuildInfo>

---

GetComponentClasses()

GetComponentClasses(): readonly unknown[];

Every component class this build carries (core and features').

Returns

readonly unknown[]

---

GetCurrentProject()

GetCurrentProject(): IProject | null;

Returns

IProject | null

Implementation of

IEngine.GetCurrentProject

---

GetDebugDrawSystem()

GetDebugDrawSystem(): DebugDrawSystem | null;

Returns

DebugDrawSystem | null

---

GetDeltaTime()

GetDeltaTime(): number;

Returns

number

---

GetFeatures()

GetFeatures(): readonly EngineFeature[];

The optional features this engine was built with.

Returns

readonly EngineFeature[]

---

GetFixedStep()

GetFixedStep(): number;

Returns

number

---

GetGameTime()

GetGameTime(): number;

Returns

number

---

GetInput()

GetInput(): IInput;

Returns

IInput

Implementation of

IEngine.GetInput

---

GetLastFrameTime()

GetLastFrameTime(): number;

Returns

number

Implementation of

IEngine.GetLastFrameTime

---

GetLastFrameTimeMs()

GetLastFrameTimeMs(): number;

Returns

number

---

GetLastRenderPasses()

GetLastRenderPasses(): number;

One per active camera, not a GPU draw-call count.

Returns

number

---

GetLastRenderTimeMs()

GetLastRenderTimeMs(): number;

Returns

number

---

GetLastTickTime()

GetLastTickTime(): number;

Returns

number

Implementation of

IEngine.GetLastTickTime

---

GetLastTickTimeMs()

GetLastTickTimeMs(): number;

Timings and the FPS / TPS averages are measured in dev builds only — 0 in production.

Returns

number

---

GetLocalization()

GetLocalization(): Localization;

Outlives scenes and sessions: the player's language stays picked across Play / scene loads.

Returns

Localization

Implementation of

IEngine.GetLocalization

---

GetPerfOverlaySystem()

GetPerfOverlaySystem(): PerfOverlaySystem | null;

Returns

PerfOverlaySystem | null

---

GetPerfProfiler()

GetPerfProfiler(): PerfProfiler | null;

Dev-only per-system timing. Null in production builds. Enable via engine.GetPerfProfiler()?.SetEnabled(true), then read GetFrames() / GetAverages().

Returns

PerfProfiler | null

---

GetPhysics2D()

GetPhysics2D(): 
  | Physics2DSystem
  | null;

2D physics (Game.physics2D wraps it). A new backend or a changed pixels-per-metre rebuilds the running world; null switches physics off. null without the 2D physics feature (EngineOptions.features).

Returns

| Physics2DSystem | null

---

GetPhysicsTimeMs()

GetPhysicsTimeMs(): number;

Per-frame ms (smoothed over ~20 frames) in 2D physics (step, body sync, poses) and in game code (script hooks, events, scheduled callbacks, animation events). Script time spent inside physics (contact callbacks) counts as scripts.

Returns

number

---

GetRenderer()

GetRenderer(): IRenderer;

Returns

IRenderer

Implementation of

IEngine.GetRenderer

---

GetRendererStats()

GetRendererStats(): IRendererStats | null;

Returns

IRendererStats | null

---

GetScheduler()

GetScheduler(): SystemScheduler;

Returns

SystemScheduler

---

GetScriptTimeMs()

GetScriptTimeMs(): number;

Returns

number

---

GetStatsOverlaySystem()

GetStatsOverlaySystem(): StatsOverlaySystem | null;

Returns

StatsOverlaySystem | null

---

GetTargetFps()

GetTargetFps(): number;

Returns

number

Implementation of

IEngine.GetTargetFps

---

GetTargetTps()

GetTargetTps(): number;

Returns

number

Implementation of

IEngine.GetTargetTps

---

GetTimeScale()

GetTimeScale(): number;

Game clock — see Game.time.

Returns

number

Implementation of

IEngine.GetTimeScale

---

GetUnscaledGameTime()

GetUnscaledGameTime(): number;

Returns

number

---

GetUpdateCount()

GetUpdateCount(): number;

Returns

number

---

HasFeature()

HasFeature(id): boolean;

Parameters

Parameter	Type
id	string

Returns

boolean

---

HasViewOverride()

HasViewOverride(): boolean;

Frames render through an editor view instead of the scene's cameras (Engine.SetViewOverride).

Returns

boolean

Implementation of

IEngine.HasViewOverride

---

Init()

Init(rendererData): Promise<boolean>;

Parameters

Parameter	Type
rendererData	RendererData

Returns

Promise<boolean>

Implementation of

IEngine.Init

---

IsDebugDrawEnabled()

IsDebugDrawEnabled(): boolean;

Returns

boolean

---

IsHeldByHost()

IsHeldByHost(): boolean;

Held by the ad container (paused by the network, or not on screen) — see m_networkPaused.

Returns

boolean

---

IsInitialized()

IsInitialized(): boolean;

Returns

boolean

Implementation of

IEngine.IsInitialized

---

IsPaused()

IsPaused(): boolean;

Returns

boolean

Implementation of

IEngine.IsPaused

---

IsPerfOverlayEnabled()

IsPerfOverlayEnabled(): boolean;

Returns

boolean

---

IsSimulationEnabled()

IsSimulationEnabled(): boolean;

False in edit mode — update phases are skipped (Engine.SetSimulationEnabled).

Returns

boolean

Implementation of

IEngine.IsSimulationEnabled

---

IsStatsEnabled()

IsStatsEnabled(): boolean;

Returns

boolean

---

RegisterSystem()

RegisterSystem(system): void;

Parameters

Parameter	Type
system	ISystem

Returns

void

Implementation of

IEngine.RegisterSystem

---

RenderCamerasToCanvas()

RenderCamerasToCanvas(width, height): HTMLCanvasElement | null;

The screen as the scene's cameras draw it, at width × height, into a new canvas — each screen camera rendered offscreen into its viewport rect and laid over the ones before it. The live view is untouched (the editor's project thumbnail). Null without OffscreenCapability.

Parameters

Parameter	Type
width	number
height	number

Returns

HTMLCanvasElement | null

---

RenderToCanvas()

RenderToCanvas(
   config, 
   width, 
   height
): HTMLCanvasElement | null;

Renders the active scene through config into an offscreen canvas (thumbnails, previews), using what the render systems last pushed — so call it after a rendered frame. Null when the backend has no OffscreenCapability.

Parameters

Parameter	Type
config	CameraConfig
width	number
height	number

Returns

HTMLCanvasElement | null

---

Run()

Run(project): boolean;

Parameters

Parameter	Type
project	IProject

Returns

boolean

Implementation of

IEngine.Run

---

SetBackend()

SetBackend(backend): Promise<void>;

Swap RENDERER backends at runtime. Tears down the current one, stands up the new one, and notifies every registered system via OnRendererChanged so they drop cached handles and re-acquire capabilities. ECS state is preserved — drawables reappear on the next tick. Audio is on its own backend axis and is left untouched.

Parameters

Parameter	Type
backend	IBackend

Returns

Promise<void>

Implementation of

IEngine.SetBackend

---

SetBuildInfo()

SetBuildInfo(info): void;

The editor's Play (the active build profile); a build sets it once through EngineOptions.build.

Parameters

Parameter	Type
info	Partial<BuildInfo>

Returns

void

---

SetCameraPreview()

SetCameraPreview(camera, rect?): void;

Editor hook — after the frame's passes, also draw camera's view into rect (canvas pixels): the Scene view's camera preview inset. null removes it.

Parameters

Parameter	Type	Default value
camera	number | null	undefined
rect	CameraPreviewRect | null	null

Returns

void

---

SetDebugDrawEnabled()

SetDebugDrawEnabled(enabled): void;

Dev overlays. All Set/Get/Is variants below are no-ops or return null in production because the backing systems are never constructed there.

Parameters

Parameter	Type
enabled	boolean

Returns

void

---

SetOverlayCamera()

SetOverlayCamera(camera): void;

Editor hook — the camera whose view the debug / editor overlay is drawn through when the scene's own cameras render (the Game view): the one showing the selection. null = the last pass.

Parameters

Parameter	Type
camera	number | null

Returns

void

---

SetParticlePreview()

SetParticlePreview(roots, speed?): void;

Editor hook — in edit mode, play the particle systems at and under roots (the selection) at speed; null / empty stops and clears them. No effect while the game runs.

Parameters

Parameter	Type	Default value
roots	readonly number[] | null	undefined
speed	number	1

Returns

void

---

SetPaused()

SetPaused(paused): void;

Editor hook — freezes the update phases without detaching their systems (unlike SetSimulationEnabled(false), scripts keep their state). StepFrame runs exactly one update.

Parameters

Parameter	Type
paused	boolean

Returns

void

---

SetPerfOverlayEnabled()

SetPerfOverlayEnabled(enabled): void;

Parameters

Parameter	Type
enabled	boolean

Returns

void

---

SetPhysics2DBackend()

SetPhysics2DBackend(backend): void;

Parameters

Parameter	Type
backend	IPhysics2DBackend | null

Returns

void

---

SetPhysics2DSettings()

SetPhysics2DSettings(settings): void;

Parameters

Parameter	Type
settings	Partial<Physics2DSettings>

Returns

void

---

SetSimulationEnabled()

SetSimulationEnabled(enabled): void;

Editor hook — false runs render phases only (scene draws, nothing simulates).

Parameters

Parameter	Type
enabled	boolean

Returns

void

---

SetStatsEnabled()

SetStatsEnabled(enabled): void;

Parameters

Parameter	Type
enabled	boolean

Returns

void

---

SetTargetFps()

SetTargetFps(fps): void;

Most frames drawn per second; 0 (or anything not a positive number) draws every display refresh.

Parameters

Parameter	Type
fps	number

Returns

void

---

SetTargetTps()

SetTargetTps(tps): void;

Fixed updates per second — the update phases' step, so also the physics step.

Parameters

Parameter	Type
tps	number

Returns

void

---

SetTimeScale()

SetTimeScale(scale): void;

Parameters

Parameter	Type
scale	number

Returns

void

---

SetViewOverride()

SetViewOverride(config, stackCameras?): void;

Editor hook — render through config instead of the scene's cameras; null restores them. stackCameras keeps the cameras' layering under that view: their depth order and culling masks, one pass each (renderStackedOverride).

Parameters

Parameter	Type	Default value
config	CameraConfig | null	undefined
stackCameras	boolean	false

Returns

void

---

StepFrame()

StepFrame(): void;

Returns

void

---

Stop()

Stop(): void;

Returns

void

Implementation of

IEngine.Stop

---

TextureToCanvas()

TextureToCanvas(assetId): HTMLCanvasElement | null;

A loaded texture asset's current pixels — e.g. what a camera last drew into a render texture.

Parameters

Parameter	Type
assetId	string

Returns

HTMLCanvasElement | null

---

UnregisterSystem()

UnregisterSystem(system): void;

Parameters

Parameter	Type
system	ISystem

Returns

void

Implementation of

IEngine.UnregisterSystem