API Docs for: 0.1.0
Show:

zerk.game.engine.system Class

Extends zerk.observable
Defined in: src/zerk/class/game/engine/system.js:1
Module: zerk

System

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

Methods

_getConfigDefaults

() Object protected

Defined in src/zerk/class/game/engine/system.js:222

Returns the configuration defaults of the system

Returns:

Object: Default configuration

_getSystem

(
  • name
)
zerk.game.engine.system protected

Defined in src/zerk/class/game/engine/system.js:231

Returns system by given name

This method is used to communicate with other systems.

Parameters:

  • name String

    System name

Returns:

zerk.game.engine.system: System instance

_log

(
  • message
  • severity
)
protected

Defined in src/zerk/class/game/engine/system.js:247

Local log method

Parameters:

  • message String

    Log message

  • severity Integer

    Log severity

addEntity

(
  • entity
)

Defined in src/zerk/class/game/engine/system.js:152

Adds an entity to the system

Parameters:

fireEvent

(
  • event
)
Boolen

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

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

getName

() String

Defined in src/zerk/class/game/engine/system.js:128

Returns the name of the system

Returns:

String: System name

getPriority

() Integer

Defined in src/zerk/class/game/engine/system.js:140

Returns the priority of the system

Returns:

Integer: System priority

getThread

() String

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

Returns the thread the systems runs in

Returns:

String: Thread name

init

(
  • engine
  • config
)

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

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

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

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

removeEntity

(
  • entity
)

Defined in src/zerk/class/game/engine/system.js:164

Removes an entity from the system

Parameters:

start

()

Defined in src/zerk/class/game/engine/system.js:187

Starts the system

stop

()

Defined in src/zerk/class/game/engine/system.js:194

Stops the system

un

(
  • event
  • callback
)
Boolen

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

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

update

()

Defined in src/zerk/class/game/engine/system.js:201

Updates the system

Fired every tick.

useComponent

(
  • name
)
Boolean

Defined in src/zerk/class/game/engine/system.js:210

Returns true when the system is interested in given component

This method is used by the engine to decide whether entities containing this component should be added to the system.

Parameters:

  • name String

    Component name

Returns:

Boolean: True when the system is intereseted in given component

Properties

_config

Object protected

Defined in src/zerk/class/game/engine/system.js:77

System configuration

_engine

zerk.game.engine protected

Defined in src/zerk/class/game/engine/system.js:55

Engine instance

Back reference to the engine instance.

_entities

Array protected

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

Entities register

Entities that this system is interested in.

_eventListeners

Array protected

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

List of event handlers

_name

String protected

Defined in src/zerk/class/game/engine/system.js:18

Name of the system

_priority

Integer protected

Defined in src/zerk/class/game/engine/system.js:44

Priority of this system

Priorities handle the order in which systems are processed.

_thread

String protected

Defined in src/zerk/class/game/engine/system.js:30

Thread that runs this system

Can be:
- simulation
- render
- none