Class Xbox360Pad

Defines a XBox360 gamepad

Hierarchy (View Summary)

Gamepad
- Xbox360Pad

Constructors

constructor

new Xbox360Pad(
    id: string,
    index: number,
    gamepad: any,
    xboxOne?: boolean,
): Xbox360Pad
Creates a new XBox360 gamepad object
Parameters
- id: string
  defines the id of this gamepad
- index: number
  defines its index
- gamepad: any
  defines the internal HTML gamepad object
- xboxOne: boolean = false
  defines if it is a XBox One gamepad
Returns Xbox360Pad
Overrides Gamepad.constructor
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:90

Properties

browserGamepad

browserGamepad: any

The browser gamepad

id

id: string

The id of the gamepad

index

index: number

The index of the gamepad

onButtonDownObservable

onButtonDownObservable: Observable<Xbox360Button> = ...

Observable raised when a button is pressed

onButtonUpObservable

onButtonUpObservable: Observable<Xbox360Button> = ...

Observable raised when a button is released

onPadDownObservable

onPadDownObservable: Observable<Xbox360Dpad> = ...

Observable raised when a pad is pressed

onPadUpObservable

onPadUpObservable: Observable<Xbox360Dpad> = ...

Observable raised when a pad is released

type

type: number

Specifies what type of gamepad this represents

`Static`DUALSHOCK

DUALSHOCK: number = 4

Represents an Dual Shock controller

`Static`GAMEPAD

GAMEPAD: number = 0

Represents a gamepad controller

`Static`GENERIC

GENERIC: number = 1

Represents a generic controller

`Static`POSE_ENABLED

POSE_ENABLED: number = 3

Represents a pose-enabled controller

`Static`XBOX

XBOX: number = 2

Represents an XBox controller

Accessors

buttonA

get buttonA(): number
Gets the value of the A button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:219
set buttonA(value: number): void
Sets the value of the A button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:225

buttonB

get buttonB(): number
Gets the value of the B button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:232
set buttonB(value: number): void
Sets the value of the B button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:238

buttonBack

get buttonBack(): number
Gets the value of the Back button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:284
set buttonBack(value: number): void
Sets the value of the Back button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:290

buttonLB

get buttonLB(): number
Gets the value of the Left button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:298
set buttonLB(value: number): void
Sets the value of the Left button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:305

buttonLeftStick

get buttonLeftStick(): number
Gets the value of the Left joystick

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:327
set buttonLeftStick(value: number): void
Sets the value of the Left joystick
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:333

buttonRB

get buttonRB(): number
Gets the value of the Right button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:313
set buttonRB(value: number): void
Sets the value of the Right button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:320

buttonRightStick

get buttonRightStick(): number
Gets the value of the Right joystick

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:340
set buttonRightStick(value: number): void
Sets the value of the Right joystick
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:346

buttonStart

get buttonStart(): number
Gets the value of the Start button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:271
set buttonStart(value: number): void
Sets the value of the Start button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:277

buttonX

get buttonX(): number
Gets the value of the X button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:245
set buttonX(value: number): void
Sets the value of the X button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:251

buttonY

get buttonY(): number
Gets the value of the Y button

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:258
set buttonY(value: number): void
Sets the value of the Y button
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:264

dPadDown

get dPadDown(): number
Gets the value of D-pad down

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:366
set dPadDown(value: number): void
Sets the value of D-pad down
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:372

dPadLeft

get dPadLeft(): number
Gets the value of D-pad left

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:379
set dPadLeft(value: number): void
Sets the value of D-pad left
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:385

dPadRight

get dPadRight(): number
Gets the value of D-pad right

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:392
set dPadRight(value: number): void
Sets the value of D-pad right
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:398

dPadUp

get dPadUp(): number
Gets the value of D-pad up

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:353
set dPadUp(value: number): void
Sets the value of D-pad up
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:359

isConnected

get isConnected(): boolean
Specifies if the gamepad has been connected

Returns boolean
Inherited from Gamepad.isConnected
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:106

leftStick

get leftStick(): StickValues
Gets the left joystick

Returns StickValues
Inherited from Gamepad.leftStick
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:170
set leftStick(newValues: StickValues): void
Sets the left joystick values
Parameters
- newValues: StickValues
Returns void
Inherited from Gamepad.leftStick
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:176

leftTrigger

get leftTrigger(): number
Gets the left trigger value

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:115
set leftTrigger(newValue: number): void
Sets the left trigger value
Parameters
- newValue: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:121

rightStick

get rightStick(): StickValues
Gets the right joystick

Returns StickValues
Inherited from Gamepad.rightStick
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:185
set rightStick(newValues: StickValues): void
Sets the right joystick value
Parameters
- newValues: StickValues
Returns void
Inherited from Gamepad.rightStick
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:191

rightTrigger

get rightTrigger(): number
Gets the right trigger value

Returns number
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:131
set rightTrigger(newValue: number): void
Sets the right trigger value
Parameters
- newValue: number
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:137

Methods

dispose

dispose(): void
Disposes the gamepad

Returns void
Overrides Gamepad.dispose
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:447

onbuttondown

onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void
Defines the callback to call when a button is pressed
Parameters
- callback: (buttonPressed: Xbox360Button) => void
  defines the callback to use
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:148

onbuttonup

onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void
Defines the callback to call when a button is released
Parameters
- callback: (buttonReleased: Xbox360Button) => void
  defines the callback to use
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:156

ondpaddown

ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void
Defines the callback to call when a pad is pressed
Parameters
- callback: (dPadPressed: Xbox360Dpad) => void
  defines the callback to use
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:164

ondpadup

ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void
Defines the callback to call when a pad is released
Parameters
- callback: (dPadReleased: Xbox360Dpad) => void
  defines the callback to use
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:172

onleftstickchanged

onleftstickchanged(callback: (values: StickValues) => void): void
Callback triggered when the left joystick has changed
Parameters
- callback: (values: StickValues) => void
  callback to trigger
Returns void
Inherited from Gamepad.onleftstickchanged
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:155

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
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:100

onrightstickchanged

onrightstickchanged(callback: (values: StickValues) => void): void
Callback triggered when the right joystick has changed
Parameters
- callback: (values: StickValues) => void
  callback to trigger
Returns void
Inherited from Gamepad.onrightstickchanged
- Defined in packages/dev/core/src/Gamepads/gamepad.ts:163

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
Returns void
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:108

update

update(): void
Force the gamepad to synchronize with device values

Returns void
Overrides Gamepad.update
- Defined in packages/dev/core/src/Gamepads/xboxGamepad.ts:405

Class Xbox360Pad

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Xbox360Pad

Properties

browserGamepad

id

index

onButtonDownObservable

onButtonUpObservable

onPadDownObservable

onPadUpObservable

type

StaticDUALSHOCK

StaticGAMEPAD

StaticGENERIC

StaticPOSE_ENABLED

StaticXBOX

Accessors

buttonA

Returns number

Parameters

Returns void

buttonB

Returns number

Parameters

Returns void

buttonBack

Returns number

Parameters

Returns void

buttonLB

Returns number

Parameters

Returns void

buttonLeftStick

Returns number

Parameters

Returns void

buttonRB

Returns number

Parameters

Returns void

buttonRightStick

Returns number

Parameters

Returns void

buttonStart

Returns number

Parameters

Returns void

buttonX

Returns number

Parameters

Returns void

buttonY

Returns number

Parameters

Returns void

dPadDown

Returns number

Parameters

Returns void

dPadLeft

Returns number

Parameters

Returns void

dPadRight

Returns number

Parameters

Returns void

dPadUp

Returns number

`Static`DUALSHOCK

`Static`GAMEPAD

`Static`GENERIC

`Static`POSE_ENABLED

`Static`XBOX