Class Engine

The starting point of an Ineka game application.

Hierarchy

Engine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Engine(options: EngineOptions): Engine

- Defined in src/core/Engine.ts:56
Merge given options with defaults and calls the engine's init method.

Parameters
- options: EngineOptions
  
  Engine's options
Returns Engine

Properties

Private _container

_container: HTMLElement

Engine container element.

Private _options

_options: EngineOptions

Engine's options (merged with defaults in constructor).

Private _systems

_systems: Map<string, OuterNode> = ...

Engine's attached systems.

Private _time

_time: Time = ...

Engine's time utility.

rootNode

rootNode: TreeNode

Root node of the engine's graph.

Accessors

container

get container(): HTMLElement

- Defined in src/core/Engine.ts:40
Get engine's container element.

readonly
Returns HTMLElement

options

get options(): EngineOptions

- Defined in src/core/Engine.ts:35
Get engine's options.

readonly
Returns EngineOptions

systems

get systems(): Map<string, OuterNode>

- Defined in src/core/Engine.ts:45
Get engine's systems.

readonly
Returns Map<string, OuterNode>

time

get time(): Time

- Defined in src/core/Engine.ts:50
Get engine's time utility.

readonly
Returns Time

Methods

Private init

init(): void

- Defined in src/core/Engine.ts:74
Inits the engine by registering default core systems.

Returns void

run

run(): void

- Defined in src/core/Engine.ts:79
Loads systems/rootNode and starts the update loops.

Returns void

Protected step

step(now: number): void

- Defined in src/core/Engine.ts:99
Update loop function, uses notions from this article to fix the timestep for fixed update loops (useful for physics and user interactions).

Parameters
- now: number
Returns void

Generated using TypeDoc