com.projectkorra.projectkorra.util

Enum ClickType

java.lang.Object

java.lang.Enum<ClickType>

com.projectkorra.projectkorra.util.ClickType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClickType>

public enum ClickType
extends java.lang.Enum<ClickType>

An enum representation of the ways in which an ability can be activated.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Use this to call your own click type.
LEFT_CLICK Player has swung their arm.
LEFT_CLICK_ENTITY For any instance of right clicking that isn't with an entity or a block (Right clicking air will not work).
RIGHT_CLICK Player has left clicked and hit an entity.
RIGHT_CLICK_BLOCK Specifically for right clicking a block.
RIGHT_CLICK_ENTITY Specifically for right clicking an entity.
SHIFT_DOWN The shift key being released.
SHIFT_UP The shift key being pressed.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CUSTOM

public static final ClickType CUSTOM

Use this to call your own click type.

LEFT_CLICK

public static final ClickType LEFT_CLICK

Player has swung their arm.

LEFT_CLICK_ENTITY

public static final ClickType LEFT_CLICK_ENTITY

For any instance of right clicking that isn't with an entity or a block (Right clicking air will not work).

RIGHT_CLICK

public static final ClickType RIGHT_CLICK

Player has left clicked and hit an entity.

RIGHT_CLICK_ENTITY

public static final ClickType RIGHT_CLICK_ENTITY

Specifically for right clicking an entity.

RIGHT_CLICK_BLOCK

public static final ClickType RIGHT_CLICK_BLOCK

Specifically for right clicking a block.

SHIFT_DOWN

public static final ClickType SHIFT_DOWN

The shift key being released.

SHIFT_UP

public static final ClickType SHIFT_UP

The shift key being pressed.

Method Detail

values

public static ClickType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClickType c : ClickType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClickType 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