Package studio.magemonkey.fabled.data

Enum Class Click

java.lang.Object
java.lang.Enum<Click>
studio.magemonkey.fabled.data.Click
All Implemented Interfaces:
Serializable, Comparable<Click>, Constable
public enum Click extends Enum<Click>
Represents a single click in a click combination

  • Enum Constant Details

    • LEFT

      public static final Click LEFT

    • SHIFT

      public static final Click SHIFT

    • LEFT_SHIFT

      public static final Click LEFT_SHIFT

    • RIGHT_SHIFT

      public static final Click RIGHT_SHIFT

    • SPACE

      public static final Click SPACE

    • Q

      public static final Click Q

    • F

      public static final Click F

  • Field Details

  • Method Details

    • values

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

    • valueOf

      public static Click valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getById

      public static Click getById(int id)
      Retrieves a Click by ID. If an invalid ID is provided, this will instead return null.
      Parameters:
      id - click ID
      Returns:
      Click enum value or null if not found

    • getByName

      public static Click getByName(String name)
      Retrieves a Click by name. If an invalid name is provided, this will return null instead.
      Parameters:
      name - click name
      Returns:
      Click enum value or null if not found

    • getId

      public int getId()
      Returns:
      numeric ID of the click type

    • getKey

      public String getKey()
      Returns:
      config key for the click

    • getName

      public String getName()
      Retrieves the formatted name of the click type
      Returns:
      formatted click type name