API Docs for: 0.1.0
Show:

zerk.game.engine.worldLoader Class

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

World Loader

Loads world definitions from JSON files.

Methods

_loadEntities

(
  • world
  • entities
  • successHandler
  • errorHandler
)
protected async

Defined in src/zerk/class/game/engine/worldLoader.js:114

Loads given entities

Parameters:

  • world Object

    World definition

  • entities Array

    Array of entities

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

_onLoadEntities

(
  • world
  • entities
  • successHandler
  • errorHandler
)
protected

Defined in src/zerk/class/game/engine/worldLoader.js:147

Fires when the entities are loaded

Parameters:

  • world Object

    World definition

  • entities Array

    Array of entities

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

_onLoadWorld

(
  • world
  • successHandler
  • errorHandler
)
protected async

Defined in src/zerk/class/game/engine/worldLoader.js:86

Fires when the world is loaded

Parameters:

  • world Object

    World definition

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

init

(
  • engine
)

Defined in src/zerk/class/game/engine/worldLoader.js:43

Class constructor

Parameters:

loadWorld

(
  • name
  • successHandler
  • errorHandler
)
async

Defined in src/zerk/class/game/engine/worldLoader.js:57

Loads a world by given resource id

Parameters:

  • name String

    World resource id

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

Properties

_componentLoader

zerk.game.engine.componentLoader protected

Defined in src/zerk/class/game/engine/worldLoader.js:25

Component loader instance

_entityLoader

zerk.game.engine.entityLoader protected

Defined in src/zerk/class/game/engine/worldLoader.js:34

Entity loader instance

_jsonLoader

zerk.jsonLoader protected

Defined in src/zerk/class/game/engine/worldLoader.js:16

JSON loader instance