API Docs for: 0.1.0
Show:

zerk.game.engine.system.control.mouse Class

Extends zerk.observable
Defined in: src/zerk/class/game/engine/system/control/mouse.js:1
Module: zerk

Mouse Interface

Provides methods to handle mouse inputs.

Methods

_getCursorPosition

(
  • event
)
Object protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:153

Returns the position of the cursor by given mouse event

Parameters:

  • event Event

    Native mouse event

Returns:

Object: Coordinate object

_onContextMenu

(
  • event
)
Boolean protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:172

Context menu event handler

Parameters:

  • event Event

    Native event

Returns:

Boolean: Returns false

_onMouseDown

(
  • event
)
Boolean protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:188

Mouse down event handler

Parameters:

  • event Event

    Native event

Returns:

Boolean:

_onMouseMove

(
  • event
)
protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:260

Mouse move event handler

Parameters:

  • event Event

    Native event

_onMouseScroll

(
  • event
)
protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:308

Mouse scroll event handler

Parameters:

  • event Event

    Native event

_onMouseUp

(
  • event
)
Boolean protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:228

Mouse up event handler

Parameters:

  • event Event

    Native event

Returns:

Boolean: Returns false

fireEvent

(
  • event
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:112

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

init

(
  • engine
)

Inherited from zerk.observable but overwritten in src/zerk/class/game/engine/system/control/mouse.js:83

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

Inherited from zerk.observable: src/zerk/class/observable.js:38

Register event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function. Return false to cancel event bubble.

  • scope Object

    Scope to be used in callback function

un

(
  • event
  • callback
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:80

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

Properties

_control

zerk.game.engine.system.control

Defined in src/zerk/class/game/engine/system/control/mouse.js:71

Back reference to control class

_eventListeners

Array protected

Inherited from zerk.observable: src/zerk/class/observable.js:18

List of event handlers

_lastMousePosition

Object protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:53

Coordinates of the last mouse position

_mouseJointActive

Boolean protected

Defined in src/zerk/class/game/engine/system/control/mouse.js:62

State of the mouse joint

mouseLeftDown

Boolean

Defined in src/zerk/class/game/engine/system/control/mouse.js:37

State of the left mouse button

mouseRightDown

Boolean

Defined in src/zerk/class/game/engine/system/control/mouse.js:45

State of the right mouse button

mouseX

Integer

Defined in src/zerk/class/game/engine/system/control/mouse.js:21

Horizontal cursor position

mouseX

Integer

Defined in src/zerk/class/game/engine/system/control/mouse.js:29

Vertical cursor position

Events

mousedown

Defined in src/zerk/class/game/engine/system/control/mouse.js:216

Fires when a mouse button is pressed

Event Payload:

  • event DOMEvent

mouseup

Defined in src/zerk/class/game/engine/system/control/mouse.js:248

Fires when a mouse button is released

Event Payload:

  • event DOMEvent