API Docs for: 1.0.1

Grape.Mouse Class

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

Can decide whether the mouse is over it (in any view). If the mouse enters or leaves, mouseOver and mouseOut events are emitted. When global mouse events are emitted (keyPress.mouseLeft, etc.) and the mouse is over the instance, the event is emitted locally. This class works when AABB interface is implemented.

Methods

getBottom

() Number

Inherited from Grape.AABB: js\grape\etc\aabb.js:40

Returns the bottom axis.

Returns:

Number:

the bottom axis

getBounds

() Object

Inherited from Grape.AABB: js\grape\etc\aabb.js:8

Gets the left, right, top, bottom coordinates at once.

Returns:

Object:

The bounding box coordinates, should contain "left", "right", "top" and "bottom" properties

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.

getHeight

() Number

Inherited from Grape.AABB: js\grape\etc\aabb.js:56

Returns the height (bottom - top).

Returns:

Number:

the height, should be bottom - top

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

getLeft

() Number

Inherited from Grape.AABB: js\grape\etc\aabb.js:16

Returns the left axis.

Returns:

Number:

the left axis

getRight

() Number

Inherited from Grape.AABB: js\grape\etc\aabb.js:32

Returns the right axis.

Returns:

Number:

the right axis

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.

getTop

() Number

Inherited from Grape.AABB: js\grape\etc\aabb.js:24

Returns the top axis.

Returns:

Number:

the top axis

getWidth

() Number

Inherited from Grape.AABB: js\grape\etc\aabb.js:48

Returns the width (right - left).

Returns:

Number:

the width, should be right - left

isMouseOver

() Boolean

Defined in js\grape\etc\mouse.js:13

Returns the mouse is over the instance in any view.

Returns:

Boolean:

true, if mouse is over the instance in any view.

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.

Events

<mouse events>

Defined in js\grape\etc\mouse.js:52

Fires the global mouse event locally, when a global mouse event is emitted and the mouse is over the instance.

mouseOut

Defined in js\grape\etc\mouse.js:32

When the mouse enters, this event is emitted.

mouseOut

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

When the mouse leaves, this event is emitted.