API Docs for: 0.1.0
Show:

zerk.game.engine.entityLoader Class

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

Entity Loader

Provides entity defintions.

Methods

_loadComponents

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

Defined in src/zerk/class/game/engine/entityLoader.js:156

Loads the given components

Parameters:

  • entities Array

    Array of entities

  • components Array

    Array of components

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

_onLoadEntities

(
  • entities
  • successHandler
  • errorHandler
)
protected async

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

Fires when entities are loaded

Parameters:

  • entities Array

    Array of entities

  • successHandler Function

    Event handler for success

  • errorHandler Function

    Event handler for error

getComponentList

(
  • entity
)
Array

Defined in src/zerk/class/game/engine/entityLoader.js:67

Returns a list of components contained in the entity

Parameters:

Returns:

Array: Array of components

getEntity

(
  • name
)
config.entity

Defined in src/zerk/class/game/engine/entityLoader.js:52

Returns a preloaded entity

Parameters:

  • name String

    Entity name

Returns:

config.entity: The entity definition

init

(
  • jsonLoader
  • componentLoader
)

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

Class constructor

Parameters:

loadEntities

(
  • entities
  • successHandler
  • errorHandler
)
async

Defined in src/zerk/class/game/engine/entityLoader.js:88

Preloads given entities

Parameters:

  • entities Array

    Array of entities

  • 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/entityLoader.js:25

Component loader instance

_jsonLoader

zerk.jsonLoader protected

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

JSON loader instance