Namespace: Input

LittleJS Input System

Tracks keyboard down, pressed, and released
Tracks mouse buttons, position, and wheel
Tracks multiple analog gamepads
Touch input is handled as mouse input
Virtual gamepad for touch devices

Source: engineInput.js, line 1

Members

(static, constant) isTouchDevice

True if a touch device has been detected

Source: engineInput.js, line 344

(static) isUsingGamepad :Boolean

Returns true if user is using gamepad (has more recently pressed a gamepad button)

Type:

Boolean

Source: engineInput.js, line 89

(static) mousePos :Vector2

Mouse pos in world space

Type:

Vector2

Source: engineInput.js, line 74

(static) mousePosScreen :Vector2

Mouse pos in screen space

Type:

Vector2

Source: engineInput.js, line 79

(static) mouseWheel :Number

Mouse wheel delta this frame

Type:

Number

Source: engineInput.js, line 84

(static) preventDefaultInput :Boolean

Prevents input continuing to the default browser handling (false by default)

Type:

Boolean

Source: engineInput.js, line 94

Methods

(static) clearInput()

Clears all input

Source: engineInput.js, line 48

(static) gamepadIsDown(button, gamepadopt) → {Boolean}

Returns true if gamepad button is down

Parameters:

Name	Type	Attributes	Default	Description
`button`	Number
`gamepad`	Number	<optional>	0

Source: engineInput.js, line 101

Returns:

Type:: Boolean

(static) gamepadStick(stick, gamepadopt) → {Vector2}

Returns gamepad stick value

Parameters:

Name	Type	Attributes	Default	Description
`stick`	Number
`gamepad`	Number	<optional>	0

Source: engineInput.js, line 125

Returns:

Type:: Vector2

(static) gamepadWasPressed(button, gamepadopt) → {Boolean}

Returns true if gamepad button was pressed

Parameters:

Name	Type	Attributes	Default	Description
`button`	Number
`gamepad`	Number	<optional>	0

Source: engineInput.js, line 109

Returns:

Type:: Boolean

(static) gamepadWasReleased(button, gamepadopt) → {Boolean}

Returns true if gamepad button was released

Parameters:

Name	Type	Attributes	Default	Description
`button`	Number
`gamepad`	Number	<optional>	0

Source: engineInput.js, line 117

Returns:

Type:: Boolean

(static) keyIsDown(key, deviceopt) → {Boolean}

Returns true if device key is down

Parameters:

Name	Type	Attributes	Default	Description
`key`	String \| Number
`device`	Number	<optional>	0

Source: engineInput.js, line 18

Returns:

Type:: Boolean

(static) keyWasPressed(key, deviceopt) → {Boolean}

Returns true if device key was pressed this frame

Parameters:

Name	Type	Attributes	Default	Description
`key`	String \| Number
`device`	Number	<optional>	0

Source: engineInput.js, line 29

Returns:

Type:: Boolean

(static) keyWasReleased(key, deviceopt) → {Boolean}

Returns true if device key was released this frame

Parameters:

Name	Type	Attributes	Default	Description
`key`	String \| Number
`device`	Number	<optional>	0

Source: engineInput.js, line 40

Returns:

Type:: Boolean

(static) mouseIsDown(button) → {Boolean}

Returns true if mouse button is down

Parameters:

Name	Type	Description
`button`	Number

Source: engineInput.js, line 55

Returns:

Type:: Boolean

(static) mouseWasPressed(button) → {Boolean}

Returns true if mouse button was pressed

Parameters:

Name	Type	Description
`button`	Number

Source: engineInput.js, line 62

Returns:

Type:: Boolean

(static) mouseWasReleased(button) → {Boolean}

Returns true if mouse button was released

Parameters:

Name	Type	Description
`button`	Number

Source: engineInput.js, line 69

Returns:

Type:: Boolean

(static) vibrate(patternopt)

Pulse the vibration hardware if it exists

Parameters:

Name	Type	Attributes	Default	Description
`pattern`	Number \| Array	<optional>	100	single value in ms or vibration interval array

Source: engineInput.js, line 332

(static) vibrateStop()

Cancel any ongoing vibration

Source: engineInput.js, line 337