API Docs for: 1.0.1

Grape.System Class

Extends
Defined in: js\grape\game\system.js:2

A system can be added to a layer, and the layer emits all of its event to the system. The system can access the layer through the getLayer method.

Constructor

Grape.System

()

Defined in js\grape\game\system.js:2

Item Index

Methods

Events

Methods

emit

(
  • event
  • payload
)

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:107

Emits an event to the instance: calls all event listeners subscribed to this event, or the 'any' event.

Parameters:

  • event String

    Event

  • payload

    An object passed as parameter to all event listeners.

getLayer

() Grape.Layer | Undefined

Defined in js\grape\game\system.js:12

Returns the layer the system is added to.

Returns:

Grape.Layer | Undefined:

The layer

off

(
  • event
  • listener
)

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:89

Unsubscribes from an event.

Parameters:

  • event String

    Event

  • listener Function

    Event listener

on

(
  • event
  • listener
)

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:78

Subscribes to an event. The event handler will be called with this instance as context.

Parameters:

  • event String

    The event to subscribe

  • listener Function

    Event listener

Events

any

Inherited from Grape.EventEmitter: js\grape\etc\event-emitter.js:122

Emitted when any event is emitted. The parameters are the event and the payload.