API Docs for: 0.1.0
Show:

zerk.game.engine Class

Extends zerk.observable
Defined in: src/zerk/class/game/engine.js:1
Module: zerk

Game Engine

The game engine main class

Methods

_getSystemClass

(
  • name
)
String protected

Defined in src/zerk/class/game/engine.js:949

Returns the class name for given system name

Parameters:

  • name String

    System name. Not the class name.

Returns:

String: Class name of the system

_log

(
  • message
  • severity
)
protected

Defined in src/zerk/class/game/engine.js:1109

Local log method

Parameters:

  • message String

    Log message

  • severity Integer

    Log severity

_onLoadWorld

(
  • world
  • successHandler
  • errorHandler
)
protected

Defined in src/zerk/class/game/engine.js:965

Fires when the world definition is laoded

Parameters:

  • world Object

    World definition

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

_render

() protected

Defined in src/zerk/class/game/engine.js:1095

Game engine render tick

_startTimer

() protected

Defined in src/zerk/class/game/engine.js:1048

Starts the engine timer

_stopTimer

() protected

Defined in src/zerk/class/game/engine.js:1069

Stops the engine timer

_tick

() protected

Defined in src/zerk/class/game/engine.js:1081

Game engine simulation tick

_updateSystems

(
  • thread
)
protected

Defined in src/zerk/class/game/engine.js:927

Updates all systems in given thread

Parameters:

  • thread String

    Thread name

addEntity

(
  • config
)

Defined in src/zerk/class/game/engine.js:475

Creates a new entity instance with given configuration

Parameters:

addSystem

(
  • name
  • config
)
Boolean

Defined in src/zerk/class/game/engine.js:699

Adds a system to the engine

Parameters:

  • name String

    Name of the system. Not the class name.

  • config Object

    Initial config for the system

Returns:

Boolean: True on success

clearEntities

()

Defined in src/zerk/class/game/engine.js:675

Removes all entities from the world

clearSystems

()

Defined in src/zerk/class/game/engine.js:799

Removes all system from the engine

fireEvent

(
  • event
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:112

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

getEntitiesByTags

(
  • tags
)
Array

Defined in src/zerk/class/game/engine.js:621

Returns entites that contain all given tags

Parameters:

  • tags Array

    Array of tags

Returns:

Array: Array of entities

getEntityById

(
  • id
)
Null | config.entity

Defined in src/zerk/class/game/engine.js:606

Returns entity instance by given id

Parameters:

  • id String

    Entity id

Returns:

Null | config.entity: Entity or null

getEntitySystemList

(
  • entity
)
Array

Defined in src/zerk/class/game/engine.js:860

Returns a list of systems interested in given entity

Parameters:

Returns:

Array: Array of systems

getRegistry

() zerk.game.engine.registry

Defined in src/zerk/class/game/engine.js:440

Returns the game engine registry

Returns:

zerk.game.engine.registry: Returns the registry instance

getSystem

(
  • name
)
zerk.game.engine.system

Defined in src/zerk/class/game/engine.js:895

Returns a system instance

Parameters:

  • name String

    System name. Not the class name.

Returns:

zerk.game.engine.system: System instance

getTime

() Integer

Defined in src/zerk/class/game/engine.js:428

Returns current world time

Returns:

Integer: World time

init

(
  • jsonLoader
  • config
)

Inherited from zerk.observable but overwritten in src/zerk/class/game/engine.js:186

Class constructor

Parameters:

  • jsonLoader zerk.jsonLoader

    A JSON Loader instance

  • config Object

    Game configuration

isRunning

() Boolean

Defined in src/zerk/class/game/engine.js:416

Returns true if the game engine is running

Returns:

Boolean: True if the game engine is running

isSystemRegistered

(
  • name
)
Boolean

Defined in src/zerk/class/game/engine.js:914

Returns true when given system is loaded in the engine

Parameters:

  • name String

    System name. Not the class name.

Returns:

Boolean: True when the system is loaded

loadEntities

(
  • entities
  • successHandler
  • errorHandler
)
async

Defined in src/zerk/class/game/engine.js:452

Loads given entities

Parameters:

  • entities Array

    An array of entity resource ids

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

loadWorld

(
  • worldClass
  • successHandler
  • errorHandler
)
async

Defined in src/zerk/class/game/engine.js:320

Loads a world

Parameters:

  • worldClass String

    Resource id of the world to be loaded

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

on

(
  • event
  • callback
  • scope
)

Inherited from zerk.observable: src/zerk/class/observable.js:38

Register event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function. Return false to cancel event bubble.

  • scope Object

    Scope to be used in callback function

pause

()

Defined in src/zerk/class/game/engine.js:303

Pause game engine

removeEntity

(
  • Entity
)
Boolean

Defined in src/zerk/class/game/engine.js:567

Removes given entity instance from the world

Parameters:

Returns:

Boolean: Returns true on success

removeSystem

(
  • name
)
Boolean

Defined in src/zerk/class/game/engine.js:754

Removes a system from the engine

Parameters:

  • name String

    Name of the system. Not the class name.

Returns:

Boolean: True on success

reset

()

Defined in src/zerk/class/game/engine.js:355

Reset the engine

saveWorld

() String

Defined in src/zerk/class/game/engine.js:382

Save world state

Returns:

String: World state as JSON string

start

()

Defined in src/zerk/class/game/engine.js:261

Start game engine

startSystems

()

Defined in src/zerk/class/game/engine.js:818

Starts all systems

stop

()

Defined in src/zerk/class/game/engine.js:280

Stop game engine

stopSystems

()

Defined in src/zerk/class/game/engine.js:839

Stops all systems

un

(
  • event
  • callback
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:80

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

Properties

_componentLoader

zerk.game.engine.componentLoader protected

Defined in src/zerk/class/game/engine.js:42

Component loader instance

_config

Object protected

Defined in src/zerk/class/game/engine.js:69

Engine configuration

_entities

Array protected

Defined in src/zerk/class/game/engine.js:127

Entities register

_entityIdMap

Object protected

Defined in src/zerk/class/game/engine.js:136

Entity id map

_entityLoader

zerk.game.engine.entityLoader protected

Defined in src/zerk/class/game/engine.js:51

Entity loader instance

_eventListeners

Array protected

Inherited from zerk.observable: src/zerk/class/observable.js:18

List of event handlers

_jsonLoader

zerk.jsonLoader protected

Defined in src/zerk/class/game/engine.js:33

JSON loader instance

_lastEntityId

Integer protected

Defined in src/zerk/class/game/engine.js:172

Last used entity id

Used to generate the next entity id.

_registry

zerk.game.engine.registry protected

Defined in src/zerk/class/game/engine.js:24

Game engine registry

_running

Boolean protected

Defined in src/zerk/class/game/engine.js:108

Indicates that the engine is running

_system

Object protected

Defined in src/zerk/class/game/engine.js:145

System register

_systemMap

Object protected

Defined in src/zerk/class/game/engine.js:163

Map of systems by names

_threadMap

Object protected

Defined in src/zerk/class/game/engine.js:154

Entities grouped by threads for fast access

_time

Integer protected

Defined in src/zerk/class/game/engine.js:78

Total world runtime

_timer

DOMTimer protected

Defined in src/zerk/class/game/engine.js:99

World timer

_unloadingWorld

Boolean deprecated protected

Defined in src/zerk/class/game/engine.js:117

Indicates that the world is unloading

_worldInterval

Float protected

Defined in src/zerk/class/game/engine.js:87

World timer interval

_worldLoader

zerk.game.engine.worldLoader protected

Defined in src/zerk/class/game/engine.js:60

World loader instance