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

Members

(static) gamepadPrimary :number

Primary gamepad index, automatically set to first gamepad with input

Type:
  • number
Source

(static) inputPreventDefault :boolean

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

Type:
  • boolean
Source

(static, constant) isTouchDevice

True if a touch device has been detected

Source

(static) isUsingGamepad :boolean

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

Type:
  • boolean
Source

(static) mouseDelta :Vector2

Mouse movement delta in world space

Type:
  • Vector2
Source

(static) mouseDeltaScreen :Vector2

Mouse movement delta in screen space

Type:
  • Vector2
Source

(static) mouseInWindow :boolean

True if mouse was inside the document window, set to false when mouse leaves

Type:
  • boolean
Source

(static) mousePos :Vector2

Mouse pos in world space

Type:
  • Vector2
Source

(static) mousePosScreen :Vector2

Mouse pos in screen space

Type:
  • Vector2
Source

(static) mouseWheel :number

Mouse wheel delta this frame

Type:
  • number
Source

Methods

(static) gamepadConnected(gamepadopt) → {boolean}

Returns true if passed in gamepad is connected

Parameters:
NameTypeAttributesDescription
gamepadnumber<optional>
Source
Returns:
Type: 
boolean

(static) gamepadDpad(gamepadopt) → {Vector2}

Returns gamepad dpad value

Parameters:
NameTypeAttributesDescription
gamepadnumber<optional>
Source
Returns:
Type: 
Vector2

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

Returns true if gamepad button is down

Parameters:
NameTypeAttributesDescription
buttonnumber
gamepadnumber<optional>
Source
Returns:
Type: 
boolean

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

Returns gamepad stick value

Parameters:
NameTypeAttributesDescription
sticknumber
gamepadnumber<optional>
Source
Returns:
Type: 
Vector2

(static) gamepadStickCount(gamepadopt) → {number}

Returns how many control sticks the passed in gamepad has

Parameters:
NameTypeAttributesDescription
gamepadnumber<optional>
Source
Returns:
Type: 
number

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

Returns true if gamepad button was pressed

Parameters:
NameTypeAttributesDescription
buttonnumber
gamepadnumber<optional>
Source
Returns:
Type: 
boolean

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

Returns true if gamepad button was released

Parameters:
NameTypeAttributesDescription
buttonnumber
gamepadnumber<optional>
Source
Returns:
Type: 
boolean

(static) inputClear()

Clears all input

Source

(static) inputClearKey(key, deviceopt, clearDownopt, clearPressedopt, clearReleasedopt)

Clears an input key state

Parameters:
NameTypeAttributesDefaultDescription
keystring | number
devicenumber<optional>
0
clearDownboolean<optional>
true
clearPressedboolean<optional>
true
clearReleasedboolean<optional>
true
Source

(static) keyDirection(upopt, downopt, leftopt, rightopt) → {Vector2}

Returns input vector from arrow keys or WASD if enabled

Parameters:
NameTypeAttributesDefaultDescription
upstring<optional>
ArrowUp
downstring<optional>
ArrowDown
leftstring<optional>
ArrowLeft
rightstring<optional>
ArrowRight
Source
Returns:
Type: 
Vector2

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

Returns true if device key is down

Parameters:
NameTypeAttributesDefaultDescription
keystring | number
devicenumber<optional>
0
Source
Returns:
Type: 
boolean

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

Returns true if device key was pressed this frame

Parameters:
NameTypeAttributesDefaultDescription
keystring | number
devicenumber<optional>
0
Source
Returns:
Type: 
boolean

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

Returns true if device key was released this frame

Parameters:
NameTypeAttributesDefaultDescription
keystring | number
devicenumber<optional>
0
Source
Returns:
Type: 
boolean

(static) mouseIsDown(button) → {boolean}

Returns true if mouse button is down

Parameters:
NameTypeDescription
buttonnumber
Source
Returns:
Type: 
boolean

(static) mouseWasPressed(button) → {boolean}

Returns true if mouse button was pressed

Parameters:
NameTypeDescription
buttonnumber
Source
Returns:
Type: 
boolean

(static) mouseWasReleased(button) → {boolean}

Returns true if mouse button was released

Parameters:
NameTypeDescription
buttonnumber
Source
Returns:
Type: 
boolean

(static) pointerLockExit()

Request to unlock the pointer

Source

(static) pointerLockIsActive() → {boolean}

Check if pointer is locked (true if locked)

Source
Returns:
Type: 
boolean

(static) pointerLockRequest()

Request to lock the pointer, does not work on touch devices

Source

(static) setInputPreventDefault(preventDefault)

Prevents input continuing to the default browser handling This is useful to disable for html menus so the browser can handle input normally

Parameters:
NameTypeDescription
preventDefaultboolean
Source

(static) vibrate(patternopt)

Pulse the vibration hardware if it exists

Parameters:
NameTypeAttributesDefaultDescription
patternnumber | Array<optional>
100

single value in ms or vibration interval array

Source

(static) vibrateStop()

Cancel any ongoing vibration

Source