Enum Class EnumFacing

java.lang.Object

java.lang.Enum<EnumFacing>

ua.mcchickenstudio.opencreative.utils.millennium.math.EnumFacing

All Implemented Interfaces:

Serializable, Comparable<EnumFacing>, Constable

public enum EnumFacing
extends Enum<EnumFacing>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EnumFacing.Axis
static enum	EnumFacing.AxisDirection
static enum	EnumFacing.Plane

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN
EAST
NORTH
SOUTH
UP
WEST

Field Summary

Fields

Modifier and Type	Field	Description
static final EnumFacing[]	VALUES	All facings in D-U-N-S-W-E order

Method Summary

Modifier and Type	Method	Description
EnumFacing.Axis	getAxis()
int	getFrontOffsetX()	Returns a offset that addresses the block in front of this facing.
int	getFrontOffsetY()
int	getFrontOffsetZ()	Returns a offset that addresses the block in front of this facing.
String	getName2()	Same as getName, but does not override the method from Enum.
EnumFacing	getOpposite()	Get the opposite Facing (e.g.
static EnumFacing	random(Random rand)	Choose a random Facing using the given Random
String	toString()
static EnumFacing	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnumFacing[]	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, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DOWN

public static final EnumFacing DOWN

UP

public static final EnumFacing UP

NORTH

public static final EnumFacing NORTH

SOUTH

public static final EnumFacing SOUTH

WEST

public static final EnumFacing WEST

EAST

public static final EnumFacing EAST

Field Details

VALUES

public static final EnumFacing[] VALUES

All facings in D-U-N-S-W-E order

Method Details

values

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

random

public static EnumFacing random(Random rand)

Choose a random Facing using the given Random

getOpposite

public EnumFacing getOpposite()

Get the opposite Facing (e.g. DOWN => UP)

getFrontOffsetX

public int getFrontOffsetX()

Returns a offset that addresses the block in front of this facing.

getFrontOffsetY

public int getFrontOffsetY()

getFrontOffsetZ

public int getFrontOffsetZ()

Returns a offset that addresses the block in front of this facing.

getName2

public String getName2()

Same as getName, but does not override the method from Enum.

toString

public String toString()

Overrides:

toString in class Enum<EnumFacing>

getAxis

public EnumFacing.Axis getAxis()