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

The game engine main class

Methods

_log

(
  • msg
)
protected

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

Local log method

Parameters:

  • msg String

_tick

() protected

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

Game engine tick

fireEvent

(
  • event
)
Boolen

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

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

getTime

() Integer

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

Returns current world time

Returns:

Integer: World time

init

(
  • config
)

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

Class constructor

Parameters:

  • config Object

    Game configuration

isRunning

() Boolean

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

Returns true if the game engine is running

Returns:

Boolean: True if the game engine is running

loadWorld

(
  • worldClass
)

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

Loads a world

Parameters:

  • worldClass String

    Class name of the world to be loaded

on

(
  • event
  • callback
  • scope
)

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

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:278

Pause game engine

saveWorld

() String

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

Save world state

Returns:

String: World state as JSON string

start

()

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

Start game engine

stop

()

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

Stop game engine

un

(
  • event
  • callback
)
Boolen

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

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

unloadWorld

()

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

Unloads the world

Properties

_config

Null | Object protected

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

Engine configuration

_eventListeners

Array protected

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

List of event handlers

_running

Boolean protected

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

Indicates that the engine is running

_time

Integer protected

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

Total world runtime

_timer

Null | Timer protected

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

World timer

_unloadingWorld

Boolean protected

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

Indicates that the world is unloading

_worldInterval

Integer protected

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

World timer interval

control

zerk.game.engine.control

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

Human input controls

game

zerk.game

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

Back reference to the game class

physics

zerk.game.engine.physics

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

Physics simulation

registry

zerk.game.engine.registry

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

Game engine registry

viewport

zerk.game.engine.viewport

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

Grafical presentation

Events

tick

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

Fires every world simulation tick

worldunloaded

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

Fires after the world is unloaded