API Docs for: 0.1.0
Show:

zerk.game.engine.system.message Class

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

Message System

Render message on the display.

Methods

_clearMessages

() protected

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

Removes messages that timed out

_getConfigDefaults

() Object protected

Inherited from zerk.game.engine.system: 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

Inherited from zerk.game.engine.system: 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

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:247

Local log method

Parameters:

  • message String

    Log message

  • severity Integer

    Log severity

_renderMessages

() protected

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

Renders messages

addEntity

(
  • entity
)

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:152

Adds an entity to the system

Parameters:

clearMessages

()

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

Removes all messages

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

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:128

Returns the name of the system

Returns:

String: System name

getPriority

() Integer

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:140

Returns the priority of the system

Returns:

Integer: System priority

getThread

() String

Inherited from zerk.game.engine.system: 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/message.js:65

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

registerMessage

(
  • message
)

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

Registers a message

Parameters:

removeEntity

(
  • entity
)

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:164

Removes an entity from the system

Parameters:

start

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/message.js:99

Starts the system

stop

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/message.js:113

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

unregisterMessage

(
  • id
)

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

Unregisters a message

Parameters:

  • id String

    Message id

update

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/message.js:127

Updates the system

useComponent

(
  • name
)
Boolean

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/message.js:85

Returns true when the system is interested in given component

Parameters:

  • name String

    Component name

Returns:

Boolean: True when the system is intereseted in given component

Properties

_config

Object protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:77

System configuration

_engine

zerk.game.engine protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:55

Engine instance

Back reference to the engine instance.

_entities

Array protected

Inherited from zerk.game.engine.system: 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

_messages

Array protected

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

Text messages

_name

String protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:18

Name of the system

_priority

Integer protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/message.js:38

Priority of this system

_thread

String protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/message.js:29

Thread that runs this system

_viewport

zerk.game.engine.system.viewport protected

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

Viewport system instance

name

String

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

Name of the system