_Mouse

_Mouse

new _Mouse()

Look at the Input reference pages before reading these docs. Used to create the `mouse` input object.
Source:

Extends

Classes

_Mouse

Members

cursor :string

The mouse's CSS cursor style.
Default Value:
  • 'default'
Source:
Type:
  • string

pos :object

The mouse's position.
Source:
Type:
  • object

position :object

The mouse's position. Alias for pos.
Source:
Type:
  • object

visible :boolean

Controls whether the mouse is visible or not.
Default Value:
  • true
Source:
Type:
  • boolean

Methods

dragged(inp) → {boolean}

Source:
Parameters:
Name Type Description
inp string
Returns:
Type:
boolean
true on the first frame that the user releases the input after dragging the mouse

dragging(inp) → {number}

Source:
Parameters:
Name Type Description
inp string
Returns:
Type:
number
the amount of frames the user has been moving the mouse while pressing the input

drags(inp) → {boolean}

Source:
Parameters:
Name Type Description
inp string
Returns:
Type:
boolean
true on the first frame that the user moves the mouse while pressing the input