Enum Class PlayerBundleItemSelectEvent.Direction

java.lang.Object

java.lang.Enum<PlayerBundleItemSelectEvent.Direction>

io.papermc.paper.event.inventory.PlayerBundleItemSelectEvent.Direction

All Implemented Interfaces:

Serializable, Comparable<PlayerBundleItemSelectEvent.Direction>, Constable

Enclosing class:

PlayerBundleItemSelectEvent

public static enum PlayerBundleItemSelectEvent.Direction
extends Enum<PlayerBundleItemSelectEvent.Direction>

Represents a selection direction.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKWARD	Represents backward direction.
FORWARD	Represents forward direction.
UNKNOWN	Represents indeterminable direction.

Method Summary

Modifier and Type	Method	Description
PlayerBundleItemSelectEvent.Direction	flip()	Returns the direction opposite to this direction.
OptionalInt	getDelta()	Returns the delta integer of the direction.
static PlayerBundleItemSelectEvent.Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PlayerBundleItemSelectEvent.Direction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FORWARD

public static final PlayerBundleItemSelectEvent.Direction FORWARD

Represents forward direction.

BACKWARD

public static final PlayerBundleItemSelectEvent.Direction BACKWARD

Represents backward direction.

UNKNOWN

public static final PlayerBundleItemSelectEvent.Direction UNKNOWN

Represents indeterminable direction.

That is, for bundles with less than three item stacks inside.

Method Details

values

public static PlayerBundleItemSelectEvent.Direction[] 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 PlayerBundleItemSelectEvent.Direction 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

getDelta

public OptionalInt getDelta()

Returns the delta integer of the direction.

Directions are mapped the following:

• FORWARD to +1
• BACKWARD to -1
• UNKNOWN to OptionalInt.empty()

Returns:

the delta

flip

public PlayerBundleItemSelectEvent.Direction flip()

Returns the direction opposite to this direction.

Returns:

the flipped direction or UNKNOWN if the direction is unknown