Skip to main content

Class: TEngine

Defined in: engine/engine.ts:39

Constructors​

Constructor​

new TEngine(config, workerScope): TEngine

Defined in: engine/engine.ts:86

Parameters​

config​

TConfig

workerScope​

DedicatedWorkerGlobalScope

Returns​

TEngine

Properties​

debugPanel​

debugPanel: TDebugPanel

Defined in: engine/engine.ts:52

events​

events: TEventQueue

Defined in: engine/engine.ts:46

Event queue for the engine which will recieve all events. Events are broadcast to the active game state queue and any workers.

Add listeners to the game state queue to ensure they are only called when the game state is active.

gameState​

gameState: TGameStateManager

Defined in: engine/engine.ts:51

inputManager​

inputManager: TInputManager

Defined in: engine/engine.ts:67

jobs​

jobs: TJobManager

Defined in: engine/engine.ts:59

mouse?​

optional mouse?: TMouseLocation

Defined in: engine/engine.ts:66

renderingSize​

renderingSize: object

Defined in: engine/engine.ts:54

height​

height: number

width​

width: number

resources​

resources: TResourceManager

Defined in: engine/engine.ts:50

segmentTimer​

segmentTimer: TSegmentTimer

Defined in: engine/engine.ts:48

Methods​

addEngineSystem()​

addEngineSystem(system): void

Defined in: engine/engine.ts:338

Add a system to the engine.

Parameters​

system​

TEngineSystem

The system to add.

Returns​

void

getEngineSystem()​

getEngineSystem<T>(systemClass): T | undefined

Defined in: engine/engine.ts:368

Get a system from the engine.

Type Parameters​

T​

T extends TEngineSystem

Parameters​

systemClass​

(...args) => TEngineSystem

The class of the system to get.

Returns​

T | undefined

The system, or undefined if it is not found.

onMessage()​

onMessage(ev): Promise<void>

Defined in: engine/engine.ts:145

Parameters​

ev​

MessageEvent

Returns​

Promise<void>

removeEngineSystem()​

removeEngineSystem(system): void

Defined in: engine/engine.ts:354

Remove a system from the engine.

Parameters​

system​

TEngineSystem

The system to remove.

Returns​

void

updateEngineContext()​

updateEngineContext(data): void

Defined in: engine/engine.ts:324

Parameters​

data​

TEngineContextData

Returns​

void

updateGameContext()​

updateGameContext(data): void

Defined in: engine/engine.ts:315

Parameters​

data​

TGameContextData

Returns​

void