API Docs for: 1.4.0
Show:

Kiwi.Input.MouseCursor Class

Extends Pointer
Defined in: src\input\MouseCursor.ts:10
Module: Input
Parent Module: Kiwi

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

Methods

objType

() String public

Defined in src\input\MouseCursor.ts:21

The type of object this class is.

Returns:

String:

"MouseCursor"

start

(
  • event
)
public

Defined in src\input\MouseCursor.ts:105

Gets executed when the mouse cursor gets initally pressed.

Parameters:

  • event Event

stop

(
  • event
)
public

Defined in src\input\MouseCursor.ts:123

Gets executed when the mouse cursor gets initally released.

Parameters:

  • event Event

wheel

(
  • event
)
public

Defined in src\input\MouseCursor.ts:137

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

Parameters:

  • event Event

Properties

altKey

Boolean public

Defined in src\input\MouseCursor.ts:65

If the alt key is down.

button

Number public

Defined in src\input\MouseCursor.ts:73

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

ctrlKey

Boolean public

Defined in src\input\MouseCursor.ts:49

If the ctrl key is down.

preventDown

Boolean public

Defined in src\input\MouseCursor.ts:81

Indicates if the "preventDefault" method should be executed whenever a 'down' mouse event occurs.

preventUp

Boolean public

Defined in src\input\MouseCursor.ts:89

Indicates if the "preventDefault" method should be executed whenever a 'up' mouse event occurs.

preventWheel

Boolean public

Defined in src\input\MouseCursor.ts:97

Indicates if the "preventDefault" method should be executed whenever a 'wheel' mouse event occurs.

shiftKey

Boolean public

Defined in src\input\MouseCursor.ts:57

If the shift key is down.

wheelDeltaX

Number public

Defined in src\input\MouseCursor.ts:31

The offset of the mouse wheel on the X axis.

Default: 0

wheelDeltaY

Number public

Defined in src\input\MouseCursor.ts:40

The offset of the mouse wheel on the Y axis.

Default: 0