Class PS4Controller

The PS4Controller class models a single PS4 controller connected to the computer, providing ButtonInput & SliderInput properties for the various inputs on the controller.

Hierarchy

PS4Controller

Implements

IGamepad

Index

Constructors

Accessors

L1 L2 L3 L3_X L3_Y L3_magnitude L3_rotation PS R1 R2 R3 R3_X R3_Y R3_magnitude R3_rotation axes buttons circle down left options right share square touchpad triangle typeName up x

Methods

canMatch update

Constructors

constructor

new PS4Controller(): PS4Controller
Returns PS4Controller
- Defined in PS4Controller.ts:132

Accessors

L1

get L1(): ButtonInput
ButtonInput for L1.

Returns ButtonInput
- Defined in PS4Controller.ts:28

L2

get L2(): ButtonInput
ButtonInput for L2. Supports pressure sensitivity.

Returns ButtonInput
- Defined in PS4Controller.ts:32

L3

get L3(): ButtonInput
ButtonInput for L3 (when you push in the left analog stick).

Returns ButtonInput
- Defined in PS4Controller.ts:84

L3_X

get L3_X(): SliderInput
SliderInput for the X-axis of the left analog stick. -1 = fully left, +1 = fully right

Returns SliderInput
- Defined in PS4Controller.ts:88

L3_Y

get L3_Y(): SliderInput
SliderInput for the Y-axis of the left analog stick. -1 = fully up, +1 = fully down

Returns SliderInput
- Defined in PS4Controller.ts:92

L3_magnitude

get L3_magnitude(): SliderInput
How far away from center the L3 analog stick is. Value ranges from 0 to 1.

Returns SliderInput
- Defined in PS4Controller.ts:96

L3_rotation

get L3_rotation(): SliderInput
The angle of the L3 analog stick, measured clockwise in degrees from the stick pointing directly upwards. Values fall in the range (-180, 180]

Returns SliderInput
- Defined in PS4Controller.ts:100

PS

get PS(): ButtonInput
ButtonInput for PS button.

Returns ButtonInput
- Defined in PS4Controller.ts:124

R1

get R1(): ButtonInput
ButtonInput for R1.

Returns ButtonInput
- Defined in PS4Controller.ts:36

R2

get R2(): ButtonInput
ButtonInput for R2. Supports pressure sensitivity.

Returns ButtonInput
- Defined in PS4Controller.ts:40

R3

get R3(): ButtonInput
ButtonInput for R3 (when you push in the right analog stick).

Returns ButtonInput
- Defined in PS4Controller.ts:104

R3_X

get R3_X(): SliderInput
SliderInput for the X-axis of the right analog stick. -1 = fully left, +1 = fully right

Returns SliderInput
- Defined in PS4Controller.ts:108

R3_Y

get R3_Y(): SliderInput
SliderInput for the Y-axis of the right analog stick. -1 = fully up, +1 = fully down

Returns SliderInput
- Defined in PS4Controller.ts:112

R3_magnitude

get R3_magnitude(): SliderInput
How far away from center the R3 analog stick is. Value ranges from 0 to 1.

Returns SliderInput
- Defined in PS4Controller.ts:116

R3_rotation

get R3_rotation(): SliderInput
The angle of the R3 analog stick, measured clockwise in degrees from the stick pointing directly upwards. Values fall in the range (-180, 180]

Returns SliderInput
- Defined in PS4Controller.ts:120

axes

get axes(): SliderInput[]
The collection of all axes on the gamepad.

Returns SliderInput[]
Implementation of IGamepad.axes
- Defined in PS4Controller.ts:23

buttons

get buttons(): ButtonInput[]
The collection of all buttons on the gamepad.

Returns ButtonInput[]
Implementation of IGamepad.buttons
- Defined in PS4Controller.ts:19

circle

get circle(): ButtonInput
ButtonInput for Circle.

Returns ButtonInput
- Defined in PS4Controller.ts:52

down

get down(): ButtonInput
ButtonInput for Down on the D-Pad.

Returns ButtonInput
- Defined in PS4Controller.ts:72

left

get left(): ButtonInput
ButtonInput for Left on the D-Pad.

Returns ButtonInput
- Defined in PS4Controller.ts:64

options

get options(): ButtonInput
ButtonInput for Options.

Returns ButtonInput
- Defined in PS4Controller.ts:80

right

get right(): ButtonInput
ButtonInput for Right on the D-Pad.

Returns ButtonInput
- Defined in PS4Controller.ts:68

share

get share(): ButtonInput
ButtonInput for Share.

Returns ButtonInput
- Defined in PS4Controller.ts:76

square

get square(): ButtonInput
ButtonInput for Square.

Returns ButtonInput
- Defined in PS4Controller.ts:48

touchpad

get touchpad(): ButtonInput
ButtonInput for touchpad.

Returns ButtonInput
- Defined in PS4Controller.ts:128

triangle

get triangle(): ButtonInput
ButtonInput for Triangle.

Returns ButtonInput
- Defined in PS4Controller.ts:56

typeName

get typeName(): string
Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

Returns string
- Defined in PS4Controller.ts:16

up

get up(): ButtonInput
ButtonInput for Up on the D-Pad.

Returns ButtonInput
- Defined in PS4Controller.ts:60

x

get x(): ButtonInput
ButtonInput for X.

Returns ButtonInput
- Defined in PS4Controller.ts:44

Methods

canMatch

canMatch(gamepadObject: Gamepad): boolean
Checks if the passed in Gamepad API object can be matched to this PS4 controller, requiring that it have 16 buttons & 4 axes.

Returns
Parameters
- gamepadObject: Gamepad
  
  The Gamepad API object to potentially be matched to.
Returns boolean
Implementation of IGamepad.canMatch
- Defined in PS4Controller.ts:196

update

update(deltaMs: number): void
Automatically called by the system, shouldn't be called by consumers of the library. Updates each button and slider on the controller.
Parameters
- deltaMs: number
  
  How many milliseconds since the last update cycle
Returns void
Implementation of IGamepad.update
- Defined in PS4Controller.ts:166

Generated using TypeDoc