API Docs for: 1.0.1

Grape.GameObject Class

Extends
Defined in: js\grape\game\game-object.js:42

A GameObject is an object which can be added to a layer, and can subscribe to the layer's events with the onGlobal() method or the global-event keyword.

Constructor

Grape.GameObject

()

Defined in js\grape\game\game-object.js:42

Methods

addTag

(
  • name
)
Boolean

Inherited from Grape.Taggable: js\grape\etc\tag.js:104

Adds a tag to a taggable object.

Parameters:

  • name String

    Tag name

Returns:

Boolean:

true, if a new tag is added, false, if the tag was already added.

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.

getGame

() Grape.Game | Null

Defined in js\grape\game\game-object.js:96

Gets the current game instance through the current layer.

Returns:

Grape.Game | Null:

The current game, or null, if the lookup fails.

getLayer

() Grape.Layer

Defined in js\grape\game\game-object.js:114

Returns the layer the instance is added to.

Returns:

Grape.Layer:

The layer

getScene

() Grape.Scene | Null

Defined in js\grape\game\game-object.js:105

Gets the root layer.

Returns:

Grape.Scene | Null:

The root layer, or null, if the lookup fails.

hasTag

(
  • name
)
Boolean

Inherited from Grape.Taggable: js\grape\etc\tag.js:123

Checks if a tag is added or not.

Parameters:

  • name String

    Tag name

Returns:

Boolean:

true, if the instance has the tag

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

onGlobal

(
  • event
  • handler
)

Defined in js\grape\game\game-object.js:64

Subscribes to an event on the layer the instance is added to. If the instance is not yet added to any layers, it will subscribe when added.

Parameters:

  • event String

    Event

  • handler Function

    Event listener

remove

()

Defined in js\grape\game\game-object.js:88

Removes the instance from the layer.

removeTag

(
  • name
)

Inherited from Grape.Taggable: js\grape\etc\tag.js:133

Removes a tag from a taggable object. If the tag is not added, does nothing.

Parameters:

  • name String

    Tag name

removeTagContainer

()

Inherited from Grape.Taggable: js\grape\etc\tag.js:149

Detaches the TagContainer. The instance is no more queryable through the container.

setTagContainer

(
  • container
)

Inherited from Grape.Taggable: js\grape\etc\tag.js:84

Sets the tag container for the instance. If tags are added already, they will appear in the new container. If the instance already has a tagContainer, it will be removed first.

Parameters:

  • container TagContainer

    The container

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.