Class Gamepad

constructor

• new Gamepad(): Gamepad

• Returns Gamepad

axes

buttons

connected

deadzone

gamepad

id

index

mapping

vibrationActuator

applyDeadzone

• applyDeadzone(value): number

• Apply deadzone to the value.

  Parameters

  • value: number

    Value to apply the deadzone to.

  Returns number

  Value with the deadzone applied.

buttonExists

• buttonExists(button): boolean

• Check if a button exists in the connected public static

  Parameters

  • button: number

    Button to check status of

  Returns boolean

  True if button exists in the connected gamepad.

buttonJustPressed

• buttonJustPressed(button): boolean

• Check if a gamepad button was just pressed.

  Parameters

  • button: number

    Button to check status of

  Returns boolean

  True if button was just pressed

buttonJustReleased

• buttonJustReleased(button): boolean

• Check if a gamepad button was just released.

  Parameters

  • button: number

    Button to check status of

  Returns boolean

  True if button was just released

buttonPressed

• buttonPressed(button): boolean

• Check if gamepad button is currently pressed.

  Parameters

  • button: number

    Button to check status of

  Returns boolean

  True if button is currently pressed

disconnect

• disconnect(): void

• Disconnect the gamepad, reset connection flags.

  When a gamepad is temporarly disconnected this method should be called to reset the connection flags.

  Returns void

dispose

• dispose(): void

• Disconnect this gamepad object.

  Returns void

getAnalogueButton

• getAnalogueButton(buttonIndex): number

• Get analog button value between 0 and 1.

  If the button is not analog enabled it will return 0 if button is not pressed or 1 if the button is pressed.

  Parameters

  • buttonIndex: number

    Button to get analogue value from.

  Returns number

  Value between 0 and 1 depending how hard the button is pressed.

getAxis

• getAxis(axisIndex): number

• Get axis value between -1 and 1 depending on the direction.

  Parameters

  • axisIndex: number

    Index of the axis to get value from.

  Returns number

  Value between -1 and 1 depending on the axis direction

getGamepads

• getGamepads(): any[]

• Get gamepads connected to the system.

  Returns any[]

  Array with all gamepads connected to the system.

initialize

• initialize(): void

• Initialize the input handler.

  Must be called before accessing the data from the handler.

  Returns void

resetHaptic

• resetHaptic(): void

• Reset the haptic actuator of the gamepad. Stops all effects.

  Returns void

setGamepad

• setGamepad(gamepad): any

• Set which gamepad should be used by this gamepad instance.

  Can be used to override the gamepad attached to this object and enable multiple gamepad support.

  Parameters

  • gamepad: any

    Browser gamepad object.

  Returns any

setProductVendor

• setProductVendor(gamepad): void

• Get vendor id and product id for the connected gamepad.

  Parameters

  • gamepad: any

    Gamepad object.

  Returns void

startHapticEffect

• startHapticEffect(type, params): void

• Start a haptic effect on the gamepad.

  Parameters

  • type: GamepadHapticEffectType

    Type of the effect to start.
  • params: GamepadEffectParameters

    Parameters for the effect.

  Returns void

update

• update(): void

• Update the gamepad state.

  Should be called every frame before checking the buttons values.

  Returns void