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

Constructors

constructor

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

Accessors

L1

L2

  • get L2(): ButtonInput

  • ButtonInput for L2. Supports pressure sensitivity.

    Returns ButtonInput

L3

  • get L3(): ButtonInput

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

    Returns ButtonInput

L3_X

  • get L3_X(): SliderInput

  • SliderInput for the X-axis of the left analog stick. -1 = fully left, +1 = fully right

    Returns SliderInput

L3_Y

  • get L3_Y(): SliderInput

  • SliderInput for the Y-axis of the left analog stick. -1 = fully up, +1 = fully down

    Returns SliderInput

L3_magnitude

  • get L3_magnitude(): SliderInput

  • How far away from center the L3 analog stick is. Value ranges from 0 to 1.

    Returns SliderInput

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

PS

R1

R2

  • get R2(): ButtonInput

  • ButtonInput for R2. Supports pressure sensitivity.

    Returns ButtonInput

R3

  • get R3(): ButtonInput

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

    Returns ButtonInput

R3_X

  • get R3_X(): SliderInput

  • SliderInput for the X-axis of the right analog stick. -1 = fully left, +1 = fully right

    Returns SliderInput

R3_Y

  • get R3_Y(): SliderInput

  • SliderInput for the Y-axis of the right analog stick. -1 = fully up, +1 = fully down

    Returns SliderInput

R3_magnitude

  • get R3_magnitude(): SliderInput

  • How far away from center the R3 analog stick is. Value ranges from 0 to 1.

    Returns SliderInput

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

axes

  • get axes(): SliderInput[]

  • The collection of all axes on the gamepad.

    Returns SliderInput[]

buttons

  • get buttons(): ButtonInput[]

  • The collection of all buttons on the gamepad.

    Returns ButtonInput[]

circle

down

  • get down(): ButtonInput

  • ButtonInput for Down on the D-Pad.

    Returns ButtonInput

left

  • get left(): ButtonInput

  • ButtonInput for Left on the D-Pad.

    Returns ButtonInput

options

right

  • get right(): ButtonInput

  • ButtonInput for Right on the D-Pad.

    Returns ButtonInput

share

square

touchpad

triangle

typeName

  • get typeName(): string

  • Returns the name of this type. This can be used rather than instanceof which is sometimes unreliable.

    Returns string

up

x

Methods

canMatch

  • 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

update

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc