Package org.xjge.core

Enum Control

java.lang.Object
java.lang.Enum<Control>
org.xjge.core.Control
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Control>, java.lang.constant.Constable
public enum Control
extends java.lang.Enum<Control>
Represents an interactive component on a Gamepad such as an analog stick, button, or trigger.
Since:
2.0.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    CIRCLE
    A button typically located on the right-hand side of the gamepad.
    CROSS
    A button typically located on the right-hand side of the gamepad.
    DPAD_DOWN
    The down direction on the controllers d-pad.
    DPAD_LEFT
    The left direction on the controllers d-pad.
    DPAD_RIGHT
    The right direction on the controllers d-pad.
    DPAD_UP
    The up direction on the controllers d-pad.
    L1
    A trigger-like button usually located on the upper-left side of the gamepad.
    L2
    A responsive trigger generally located at the upper-left side of the gamepad directly under the button-like "bumper" trigger (L1).
    L3
    A button that is likely integrated directly into the gamepads left analog stick.
    LEFT_STICK_X
    Represents the analog stick located on the left-hand side of the gamepad.
    LEFT_STICK_Y
    Represents the analog stick located on the left-hand side of the gamepad.
    OPTIONS
    A button generally located somewhere in the center of the gamepad.
    PS_BUTTON
    A button typically located directly in the center of the gamepad.
    R1
    A trigger-like button usually located on the upper-right side of the gamepad.
    R2
    A responsive trigger generally located at the upper-right side of the gamepad directly under the button-like "bumper" trigger (R1).
    R3
    A button that is likely integrated directly into the gamepads right analog stick.
    RIGHT_STICK_X
    Represents the analog stick located on the right-hand side of the gamepad.
    RIGHT_STICK_Y
    Represents the analog stick located on the right-hand side of the gamepad.
    SHARE
    A button generally located somewhere in the center of the gamepad.
    SQUARE
    A button typically located on the right-hand side of the gamepad.
    TRIANGLE
    A button typically located on the right-hand side of the gamepad.

  • Method Summary

    Modifier and Type Method Description
    static Control valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static Control[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CROSS

      public static final Control CROSS
      A button typically located on the right-hand side of the gamepad.

    • CIRCLE

      public static final Control CIRCLE
      A button typically located on the right-hand side of the gamepad.

    • SQUARE

      public static final Control SQUARE
      A button typically located on the right-hand side of the gamepad.

    • TRIANGLE

      public static final Control TRIANGLE
      A button typically located on the right-hand side of the gamepad.

    • L1

      public static final Control L1
      A trigger-like button usually located on the upper-left side of the gamepad. Sometimes referred to as a bumper.

    • R1

      public static final Control R1
      A trigger-like button usually located on the upper-right side of the gamepad. Sometimes referred to as a bumper.

    • SHARE

      public static final Control SHARE
      A button generally located somewhere in the center of the gamepad.

    • OPTIONS

      public static final Control OPTIONS
      A button generally located somewhere in the center of the gamepad.

    • PS_BUTTON

      public static final Control PS_BUTTON
      A button typically located directly in the center of the gamepad. This may be the power button.

    • L3

      public static final Control L3
      A button that is likely integrated directly into the gamepads left analog stick.

    • R3

      public static final Control R3
      A button that is likely integrated directly into the gamepads right analog stick.

    • DPAD_UP

      public static final Control DPAD_UP
      The up direction on the controllers d-pad.

    • DPAD_RIGHT

      public static final Control DPAD_RIGHT
      The right direction on the controllers d-pad.

    • DPAD_DOWN

      public static final Control DPAD_DOWN
      The down direction on the controllers d-pad.

    • DPAD_LEFT

      public static final Control DPAD_LEFT
      The left direction on the controllers d-pad.

    • LEFT_STICK_X

      public static final Control LEFT_STICK_X
      Represents the analog stick located on the left-hand side of the gamepad. Command objects coupled to this control will only check for changes in its horizontal axis.

    • LEFT_STICK_Y

      public static final Control LEFT_STICK_Y
      Represents the analog stick located on the left-hand side of the gamepad. Command objects coupled to this control will only check for changes in its vertical axis.

    • RIGHT_STICK_X

      public static final Control RIGHT_STICK_X
      Represents the analog stick located on the right-hand side of the gamepad. Command objects coupled to this control will only check for changes in its horizontal axis.

    • RIGHT_STICK_Y

      public static final Control RIGHT_STICK_Y
      Represents the analog stick located on the right-hand side of the gamepad. Command objects coupled to this control will only check for changes in its vertical axis.

    • L2

      public static final Control L2
      A responsive trigger generally located at the upper-left side of the gamepad directly under the button-like "bumper" trigger (L1).

    • R2

      public static final Control R2
      A responsive trigger generally located at the upper-right side of the gamepad directly under the button-like "bumper" trigger (R1).

  • Method Details

    • values

      public static Control[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Control valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null