Interface: IEngine

Core interface types.

Methods

GetAdAdapter()

GetAdAdapter(): IAdAdapter;

Returns

IAdAdapter

---

GetAssetLoader()

GetAssetLoader(): IAssetLoader;

Returns

IAssetLoader

---

GetAudio()

GetAudio(): IAudio | null;

Returns

IAudio | null

---

GetAvgFpsCount()

GetAvgFpsCount(): number;

Returns

number

---

GetAvgTpsCount()

GetAvgTpsCount(): number;

Returns

number

---

GetCurrentProject()

GetCurrentProject(): IProject | null;

Returns

IProject | null

---

GetInput()

GetInput(): IInput;

Returns

IInput

---

GetLastFrameTime()

GetLastFrameTime(): number;

Returns

number

---

GetLastTickTime()

GetLastTickTime(): number;

Returns

number

---

GetLocalization()

GetLocalization(): Localization;

Text lookup by key in the current language (string tables).

Returns

Localization

---

GetRenderer()

GetRenderer(): IRenderer;

Returns

IRenderer

---

GetTargetFps()

GetTargetFps(): number;

Returns

number

---

GetTargetTps()

GetTargetTps(): number;

Returns

number

---

GetTimeScale()

GetTimeScale(): number;

Game time: the factor update dt is scaled by, and whether the update phases are held.

Returns

number

---

HasViewOverride()

HasViewOverride(): boolean;

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

Returns

boolean

---

Init()

Init(rendererData): Promise<boolean>;

Parameters

Parameter	Type
rendererData	RendererData

Returns

Promise<boolean>

---

IsInitialized()

IsInitialized(): boolean;

Returns

boolean

---

IsPaused()

IsPaused(): boolean;

Returns

boolean

---

IsSimulationEnabled()

IsSimulationEnabled(): boolean;

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

Returns

boolean

---

RegisterSystem()

RegisterSystem(system): void;

Parameters

Parameter	Type
system	ISystem

Returns

void

---

Run()

Run(project): boolean;

Parameters

Parameter	Type
project	IProject

Returns

boolean

---

SetBackend()

SetBackend(backend): Promise<void>;

Parameters

Parameter	Type
backend	IBackend

Returns

Promise<void>

---

Stop()

Stop(): void;

Returns

void

---

UnregisterSystem()

UnregisterSystem(system): void;

Parameters

Parameter	Type
system	ISystem

Returns

void