API Docs for: 1.0.1

Grape.Alarm Class

Extends
Defined in: js\grape\etc\alarm.js:3

A utility class for creating timeouts in a game.

Constructor

Grape.Alarm

()

Defined in js\grape\etc\alarm.js:3

Methods

getAlarm

(
  • name
)
Number

Defined in js\grape\etc\alarm.js:27

Returns the remaining frames of a timeout

Parameters:

  • name String

    Alarm name

Returns:

Number:

The remaining time

getGame

() Grape.Game | Null

Inherited from Grape.GameObject: 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

Inherited from Grape.GameObject: js\grape\game\game-object.js:114

Returns the layer the instance is added to.

Returns:

Grape.Layer:

The layer

getScene

() Grape.Scene | Null

Inherited from Grape.GameObject: js\grape\game\game-object.js:105

Gets the root layer.

Returns:

Grape.Scene | Null:

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

hasAlarm

(
  • id
)
Boolean

Defined in js\grape\etc\alarm.js:53

Tells whether a timeout with a given name exists.

Parameters:

  • id String

    Name of the timeout

Returns:

Boolean:

true, if the timeout exists

increaseAlarm

(
  • name
  • frames
)

Defined in js\grape\etc\alarm.js:38

Increases the duration of a timeout by a given amount. If timeout does not exist, the method creates it.

Parameters:

  • name String

    Alarm name

  • frames Number

    Number of frames to increase with

onGlobal

(
  • event
  • handler
)

Inherited from Grape.GameObject: 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

()

Inherited from Grape.GameObject: js\grape\game\game-object.js:88

Removes the instance from the layer.

setAlarm

(
  • name
  • frames
)

Defined in js\grape\etc\alarm.js:16

Sets a timeout with a given name in frames.

Parameters:

  • name String

    Alarm name

  • frames Number

    The number of frames after the alarm triggers

Events

alarm

Defined in js\grape\etc\alarm.js:69

When a timeout ends, this event occurs. The parameter is the name of the timeout.

alarm.<name>

Defined in js\grape\etc\alarm.js:74

When a timeout ends, this event occurs too.