Package net.uku3lig.ukulib.utils

Enum Class Position

java.lang.Object

java.lang.Enum<Position>

net.uku3lig.ukulib.utils.Position

All Implemented Interfaces:

Serializable, Comparable<Position>, Constable, net.minecraft.util.StringRepresentable, StringTranslatable

public enum Position
extends Enum<Position>
implements StringTranslatable

An enum used to represent various positions. The actual position is implementation specific.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface net.minecraft.util.StringRepresentable

net.minecraft.util.StringRepresentable.EnumCodec<E extends Enum<E> & net.minecraft.util.StringRepresentable>, net.minecraft.util.StringRepresentable.StringRepresentableCodec<S extends net.minecraft.util.StringRepresentable>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM_LEFT	The bottom left of the screen.
BOTTOM_RIGHT	The bottom right of the screen.
MIDDLE	Above the experience bar, usually between the health and hunger bars.
TOP_LEFT	The top left of the screen.
TOP_RIGHT	The top right of the screen.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY	Translation key for the position

Fields inherited from interface net.minecraft.util.StringRepresentable

PRE_BUILT_MAP_THRESHOLD

Method Summary

Modifier and Type	Method	Description
String	getName()	Name of the option, also used as its unique identifier for StringRepresentable.
static CyclingOption<Position>	getOption(Collection<Position> allowedValues, Position initialValue, Consumer<Position> setter)	Creates a CyclingOption that allows to choose between all the allowedValues.
static CyclingOption<Position>	getOption(Position initialValue, Consumer<Position> setter)	Creates a CyclingOption that allows to choose between all of this enum's values.
String	getTranslationKey()	The translation key of the option
boolean	isBottom()	Checks if the position is at the bottom of the screen.
boolean	isRight()	Checks if the position is on the right of the screen.
static Position	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Position[]	values()	Returns an array containing the constants of this enum class, 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

Methods inherited from interface net.uku3lig.ukulib.config.option.StringTranslatable

getSerializedName, getText

Enum Constant Details

TOP_LEFT

public static final Position TOP_LEFT

The top left of the screen.

TOP_RIGHT

public static final Position TOP_RIGHT

The top right of the screen.

BOTTOM_LEFT

public static final Position BOTTOM_LEFT

The bottom left of the screen.

BOTTOM_RIGHT

public static final Position BOTTOM_RIGHT

The bottom right of the screen.

MIDDLE

public static final Position MIDDLE

Above the experience bar, usually between the health and hunger bars.

Field Details

KEY

public static final String KEY

Translation key for the position

See Also:

• Constant Field Values

Method Details

values

public static Position[] 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 Position 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

isRight

public boolean isRight()

Checks if the position is on the right of the screen.

Returns:

true if the position is on the right of the screen

isBottom

public boolean isBottom()

Checks if the position is at the bottom of the screen.

Returns:

true if the position is at the bottom of the screen

getOption

public static CyclingOption<Position> getOption(Position initialValue,
 Consumer<Position> setter)

Creates a CyclingOption that allows to choose between all of this enum's values.

Parameters:

initialValue - The initial

setter - The action to be performed when the value changes

Returns:

The generated option

See Also:

• CyclingOption.ofTranslatableEnum(String, Class, Enum, Consumer)

getOption

public static CyclingOption<Position> getOption(Collection<Position> allowedValues,
 Position initialValue,
 Consumer<Position> setter)

Creates a CyclingOption that allows to choose between all the allowedValues.

Parameters:

allowedValues - The values the option will cycle through

initialValue - The initial value

setter - The action to be performed when the value changes

Returns:

The generated option

See Also:

• CyclingOption.ofTranslatable(String, Collection, StringTranslatable, Consumer)

getName

public String getName()

Description copied from interface: StringTranslatable

Name of the option, also used as its unique identifier for StringRepresentable.

Specified by:

getName in interface StringTranslatable

Returns:

The name of the option

See Also:

• StringRepresentable.getSerializedName()

getTranslationKey

public String getTranslationKey()

Description copied from interface: StringTranslatable

The translation key of the option

Specified by:

getTranslationKey in interface StringTranslatable

Returns:

The translation key