API Docs for: 1.0.1

Grape.Layer Class

Extends
Defined in: js\grape\game\layer.js:37

A layer contains instances, systems, and other layers. When any event is emitted to the layer, it is emitted to the systems and layers of the layer too. When you want to subscribe to the layer events with a GameObject (which is added to the layer) you can use the gameObject.onGlobal() function or the global-event keyword.

Constructor

Grape.Layer

(
  • opts
)

Defined in js\grape\game\layer.js:37

Parameters:

  • opts Object

    Initial properties

Methods

add

(
  • instance
)
Grape.GameObject

Defined in js\grape\game\layer.js:66

Adds an instance to the layer and emits it's "add" event.

Parameters:

Returns:

Grape.GameObject:

The added instance

addLayer

(
  • [name]
  • layer
)

Defined in js\grape\game\layer.js:235

Adds a sub-layer to the current layer.

Parameters:

  • [name] String optional

    Layer name

  • layer Grape.Layer

    Sub-layer

addSystem

(
  • [name]
  • system
)

Defined in js\grape\game\layer.js:249

Adds a system to the layer. All events are emitted to all added systems.

Parameters:

  • [name] String optional

    Name

  • system Grape.System

    The system

addView

(
  • name
  • view
)

Defined in js\grape\game\layer.js:269

Adds a view to the layer. A synonym for addSystem.

Parameters:

createResultContainer

() Grape.GameObjectArray

Inherited from Grape.TagContainer but overwritten in js\grape\game\layer.js:153

Overrides the TagContainer's method so getByTag calls produce GameObjectArray results instead of Array.

Returns:

Grape.GameObjectArray:

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.

get

(
  • classes
  • [descendants=false]
)
GameObjectArray

Inherited from Grape.TagContainer but overwritten in js\grape\game\layer.js:184

Gets the instances of one or more class in the current layer (sub-layers not included).

Parameters:

  • classes Class | Array

    Class or classes

  • [descendants=false] Boolean optional

    Get the descendants of that class or just instances of the class itself

Returns:

GameObjectArray:

Instances

getByTag

() Grape.GameObjectArray

Defined in js\grape\game\layer.js:144

Returns the instances with the given tag. Instances are indexed by tags.

Returns:

Grape.GameObjectArray:

Instances with the tag

getGame

() Grape.Game

Defined in js\grape\game\layer.js:336

Returns the current game.

Returns:

Grape.Game:

The game

getScene

() Grape.Scene

Defined in js\grape\game\layer.js:324

Returns the root layer.

Returns:

Grape.Scene:

The root layer

getSystem

(
  • name
)
Grape.System

Defined in js\grape\game\layer.js:314

Returns a system with the given name. Views are also considered as systems.

Parameters:

  • name String

    System name

Returns:

Grape.System:

System

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

remove

(
  • instance
)

Defined in js\grape\game\layer.js:119

Removes an instance from the layer and emits it's "remove" event.

Parameters:

  • instance Object

removeLayer

(
  • name
)

Defined in js\grape\game\layer.js:279

Removes a layer.

Parameters:

  • name String | Grape.Layer

    Name of the layer or the layer itself

removeSystem

(
  • system
)

Defined in js\grape\game\layer.js:288

Removes a system from the layer.

Parameters:

  • system String | Grape.System

    The name of the system or the system itself.

removeView

(
  • name
)

Defined in js\grape\game\layer.js:305

Removes a view from the layer. An alias for removeSystem.

Parameters:

  • name String | Grape.View

    View name or the view itself

Events

add (instance)

Defined in js\grape\game\layer.js:111

This event is emitted to the instance when it is added to the layer. The parameter is the layer.

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.

remove (instance)

Defined in js\grape\game\layer.js:137

Emitted to the instance when it is removed from the layer.

start (system)

Defined in js\grape\game\layer.js:260

Emitted to a system when it is added to a running layer or when the layer is started with a system added before.

stop (system)

Defined in js\grape\game\layer.js:297

Emitted to a system when it is removed from the running layer or when the layer is stopped.