API Docs for: 0.1.0
Show:

zerk.game Class

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

Game

Base class for games. All games should inherit from here.

Methods

_getConfigDefaults

() Object protected

Defined in src/zerk/class/game.js:157

Returns the default game configuration

This method should be extended by child classes to setup default game configuration.

Returns:

Object: Default configuration

_onLoadGameConfiguration

(
  • gameConfig
  • localConfig
)
protected

Defined in src/zerk/class/game.js:110

Fires when the game configuration is loaded

Parameters:

  • gameConfig Object

    Game configuration

  • localConfig Object

    Bootstrap configuration

init

(
  • config
)
async

Defined in src/zerk/class/game.js:38

Class constructor

Parameters:

  • config Object

    Game configuration

run

()

Defined in src/zerk/class/game.js:129

Run the game

This method should be extended by child classes to boot the game.

Properties

_engine

zerk.game.engine protected

Defined in src/zerk/class/game.js:20

The game engine

_jsonLoader

zerk.jsonLoader protected

Defined in src/zerk/class/game.js:29

JSON Loader