API Docs for: 1.0.0
Show:

Kiwi.Input.MouseCursor Class

Extends Pointer
Module: Input
Parent Module: Kiwi

Holds the information about a Mouse Cursor. Such as the position of the cursor, the mouse wheels delta, the button that was used, e.t.c. Note: A mouse cursor is always active.

Methods

objType

() public

The type of object this class is.

Returns:

string

start

(
  • event
)
public

Gets executed when the mouse cursor gets initally pressed.

Parameters:

  • event Event

stop

(
  • event
)
public

Gets executed when the mouse cursor gets initally released.

Parameters:

  • event Event

wheel

(
  • event
)
public

When the mouse wheel event fires and the mouse's delta changes.

Parameters:

  • event Event

Properties

altKey

Boolean public

If the alt key is down.

button

Number public

The button that got pressed. Eg. If the LEFT mouse button was pressed this number would be 0

ctrlKey

Boolean public

If the ctrl key is down.

shiftKey

Boolean public

If the shift key is down.

wheelDeltaX

Number public

The offset of the mouse wheel on the X axis.

Default: 0

wheelDeltaY

Number public

The offset of the mouse wheel on the Y axis.

Default: 0