Package wtf.choco.veinminer.pattern

Enum Class VeinMiningPatternStaircase.Direction

java.lang.Object

java.lang.Enum<VeinMiningPatternStaircase.Direction>

wtf.choco.veinminer.pattern.VeinMiningPatternStaircase.Direction

All Implemented Interfaces:

Serializable, Comparable<VeinMiningPatternStaircase.Direction>, Constable

Enclosing class:

VeinMiningPatternStaircase

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

Represents the direction in which a VeinMiningPatternStaircase may mine.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN
UP

Method Summary

Modifier and Type	Method	Description
int	getModY()	Get the modified y coordinate, either 1 or -1.
static VeinMiningPatternStaircase.Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VeinMiningPatternStaircase.Direction[]	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

Enum Constant Details

UP

public static final VeinMiningPatternStaircase.Direction UP

DOWN

public static final VeinMiningPatternStaircase.Direction DOWN

Method Details

values

public static VeinMiningPatternStaircase.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 VeinMiningPatternStaircase.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

getModY

public int getModY()

Get the modified y coordinate, either 1 or -1.

Returns:

the modified y coordinate