API Docs for: 0.1.0
Show:

zerk.game.engine.world Class

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

World

This class represents the world.

All world classes should inherit from here.

Methods

_log

(
  • msg
)
protected

Defined in src/zerk/class/game/engine/world.js:182

Local log method

Parameters:

  • msg String

    Log message

_setup

() protected

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

Defines the initial world state

_spawn

(
  • entity
  • config
)
protected

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

Creates a new entity instance with given configuration

Parameters:

clear

()

Defined in src/zerk/class/game/engine/world.js:167

Removes all entities from the world

destroy

(
  • entity
)
Boolean

Defined in src/zerk/class/game/engine/world.js:72

Removes given entity from the world

Parameters:

Returns:

Boolean: Returns true on success

getEntityById

(
  • id
)
Null | zerk.game.engine.entity

Defined in src/zerk/class/game/engine/world.js:102

Returns entity instance by given id

Parameters:

  • id String

    Entity id

Returns:

Null | zerk.game.engine.entity: Entity or null

init

(
  • engine
)

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

Class constructor

Parameters:

Properties

_config

Object protected

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

World configuration

_mapEntity

Object protected

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

Entity id to instance map

entities

Array

Defined in src/zerk/class/game/engine/world.js:17

Entities array