API Docs for: 1.0.1

Grape.Physical Class

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

Provides simple physics: velocity. In the future more features can be added like friction or acceleration

Methods

accelerate

(
  • plus
)
Grape.Physical chainable

Defined in js\grape\etc\physical.js:44

Increases the speed by a given amount, keeping the original direction.

Parameters:

  • plus Number

    The amount the speed is increased with

Returns:

Grape.Physical:

this

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.

getSpeed

() Number

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

Returns the speed of the instance, calculated by the speedX and speedY properties.

Returns:

Number:

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.

setSpeed

(
  • speed
)
Grape.Physical chainable

Defined in js\grape\etc\physical.js:25

Sets the speed of the instance, keeping the original direction (or the opposite if speed is negative). If Original speed is 0, the direction is considered as 0 (left-to right).

Parameters:

  • speed Number

    new Speed

Returns:

Grape.Physical:

this

Properties

x

Number

Inherited from Grape.Position: js\grape\etc\position.js:12

X coordinate

Default: 0

y

Number

Inherited from Grape.Position: js\grape\etc\position.js:20

Y coordinate

Default: 0