API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DualShockPad

Defines a DualShock gamepad

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DualShockPad(id: string, index: number, gamepad: any): DualShockPad

  • Creates a new DualShock gamepad object

    Parameters

    • id: string

      defines the id of this gamepad

    • index: number

      defines its index

    • gamepad: any

      defines the internal HTML gamepad object

    Returns DualShockPad

Properties

browserGamepadSearch playground for browserGamepad

browserGamepad: any

The browser gamepad

idSearch playground for id

id: string

The id of the gamepad

indexSearch playground for index

index: number

The index of the gamepad

onButtonDownObservableSearch playground for onButtonDownObservable

onButtonDownObservable: Observable<DualShockButton>

Observable raised when a button is pressed

onButtonUpObservableSearch playground for onButtonUpObservable

onButtonUpObservable: Observable<DualShockButton>

Observable raised when a button is released

onPadDownObservableSearch playground for onPadDownObservable

onPadDownObservable: Observable<DualShockDpad>

Observable raised when a pad is pressed

onPadUpObservableSearch playground for onPadUpObservable

onPadUpObservable: Observable<DualShockDpad>

Observable raised when a pad is released

typeSearch playground for type

type: number

Specifies what type of gamepad this represents

Static DUALSHOCKSearch playground for DUALSHOCK

DUALSHOCK: number

Represents an Dual Shock controller

Static GAMEPADSearch playground for GAMEPAD

GAMEPAD: number

Represents a gamepad controller

Static GENERICSearch playground for GENERIC

GENERIC: number

Represents a generic controller

Static POSE_ENABLEDSearch playground for POSE_ENABLED

POSE_ENABLED: number

Represents a pose-enabled controller

Static XBOXSearch playground for XBOX

XBOX: number

Represents an XBox controller

Accessors

buttonCircle

  • get buttonCircle(): number
  • set buttonCircle(value: number): any

  • Gets the value of the Circle button

    Returns number

  • Sets the value of the Circle button

    Parameters

    • value: number

    Returns any

buttonCross

  • get buttonCross(): number
  • set buttonCross(value: number): any

  • Gets the value of the Cross button

    Returns number

  • Sets the value of the Cross button

    Parameters

    • value: number

    Returns any

buttonL1

  • get buttonL1(): number
  • set buttonL1(value: number): any

  • Gets the value of the L1 button

    Returns number

  • Sets the value of the L1 button

    Parameters

    • value: number

    Returns any

buttonLeftStick

  • get buttonLeftStick(): number
  • set buttonLeftStick(value: number): any

  • Gets the value of the Left joystick

    Returns number

  • Sets the value of the Left joystick

    Parameters

    • value: number

    Returns any

buttonOptions

  • get buttonOptions(): number
  • set buttonOptions(value: number): any

  • Gets the value of the Options button

    Returns number

  • Sets the value of the Options button

    Parameters

    • value: number

    Returns any

buttonR1

  • get buttonR1(): number
  • set buttonR1(value: number): any

  • Gets the value of the R1 button

    Returns number

  • Sets the value of the R1 button

    Parameters

    • value: number

    Returns any

buttonRightStick

  • get buttonRightStick(): number
  • set buttonRightStick(value: number): any

  • Gets the value of the Right joystick

    Returns number

  • Sets the value of the Right joystick

    Parameters

    • value: number

    Returns any

buttonShare

  • get buttonShare(): number
  • set buttonShare(value: number): any

  • Gets the value of the Share button

    Returns number

  • Sets the value of the Share button

    Parameters

    • value: number

    Returns any

buttonSquare

  • get buttonSquare(): number
  • set buttonSquare(value: number): any

  • Gets the value of the Square button

    Returns number

  • Sets the value of the Square button

    Parameters

    • value: number

    Returns any

buttonTriangle

  • get buttonTriangle(): number
  • set buttonTriangle(value: number): any

  • Gets the value of the Triangle button

    Returns number

  • Sets the value of the Triangle button

    Parameters

    • value: number

    Returns any

dPadDown

  • get dPadDown(): number
  • set dPadDown(value: number): any

  • Gets the value of D-pad down

    Returns number

  • Sets the value of D-pad down

    Parameters

    • value: number

    Returns any

dPadLeft

  • get dPadLeft(): number
  • set dPadLeft(value: number): any

  • Gets the value of D-pad left

    Returns number

  • Sets the value of D-pad left

    Parameters

    • value: number

    Returns any

dPadRight

  • get dPadRight(): number
  • set dPadRight(value: number): any

  • Gets the value of D-pad right

    Returns number

  • Sets the value of D-pad right

    Parameters

    • value: number

    Returns any

dPadUp

  • get dPadUp(): number
  • set dPadUp(value: number): any

  • Gets the value of D-pad up

    Returns number

  • Sets the value of D-pad up

    Parameters

    • value: number

    Returns any

isConnected

  • get isConnected(): boolean

  • Specifies if the gamepad has been connected

    Returns boolean

leftStick

leftTrigger

  • get leftTrigger(): number
  • set leftTrigger(newValue: number): any

  • Gets the left trigger value

    Returns number

  • Sets the left trigger value

    Parameters

    • newValue: number

    Returns any

rightStick

rightTrigger

  • get rightTrigger(): number
  • set rightTrigger(newValue: number): any

  • Gets the right trigger value

    Returns number

  • Sets the right trigger value

    Parameters

    • newValue: number

    Returns any

Methods

disposeSearch playground for dispose

  • dispose(): void

  • Disposes the gamepad

    Returns void

onbuttondownSearch playground for onbuttondown

  • Defines the callback to call when a button is pressed

    Parameters

    Returns void

onbuttonupSearch playground for onbuttonup

  • Defines the callback to call when a button is released

    Parameters

    Returns void

ondpaddownSearch playground for ondpaddown

  • ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void

  • Defines the callback to call when a pad is pressed

    Parameters

    Returns void

ondpadupSearch playground for ondpadup

  • ondpadup(callback: (dPadReleased: DualShockDpad) => void): void

  • Defines the callback to call when a pad is released

    Parameters

    Returns void

onleftstickchangedSearch playground for onleftstickchanged

  • onleftstickchanged(callback: (values: StickValues) => void): void

onlefttriggerchangedSearch playground for onlefttriggerchanged

  • onlefttriggerchanged(callback: (value: number) => void): void

  • Defines the callback to call when left trigger is pressed

    Parameters

    • callback: (value: number) => void

      defines the callback to use

        • (value: number): void

        • Parameters

          • value: number

          Returns void

    Returns void

onrightstickchangedSearch playground for onrightstickchanged

  • onrightstickchanged(callback: (values: StickValues) => void): void

onrighttriggerchangedSearch playground for onrighttriggerchanged

  • onrighttriggerchanged(callback: (value: number) => void): void

  • Defines the callback to call when right trigger is pressed

    Parameters

    • callback: (value: number) => void

      defines the callback to use

        • (value: number): void

        • Parameters

          • value: number

          Returns void

    Returns void

updateSearch playground for update

  • update(): void

  • Force the gamepad to synchronize with device values

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method