li.cil.tis3d.api.machine

Enum Face

java.lang.Object

java.lang.Enum<Face>

li.cil.tis3d.api.machine.Face

All Implemented Interfaces:

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

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

Enumeration over the faces of a Casing.

Mainly to avoid Minecraft specific types in the API where possible. Just in case things get changed around again like has happened the last few major version bumps.

Enum Constant Summary

Enum Constants

Enum Constant and Description
X_NEG
X_POS
Y_NEG
Y_POS
Z_NEG
Z_POS

Field Summary

Fields

Modifier and Type	Field and Description
static Face[]	OPPOSITES Mapping faces to their opposites (by ordinal()).
static Face[]	VALUES All possible enum values for quick indexing.

Method Summary

Modifier and Type	Method and Description
static Face	fromEnumFacing(net.minecraft.util.EnumFacing facing) Convert a facing from Forge's format to our internal format.
Face	getOpposite() The the opposite face to this one.
static net.minecraft.util.EnumFacing	toEnumFacing(Face face) Convert a facing from our internal format to Forge's format.
static Face	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Face[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Y_NEG

public static final Face Y_NEG

Y_POS

public static final Face Y_POS

Z_NEG

public static final Face Z_NEG

Z_POS

public static final Face Z_POS

X_NEG

public static final Face X_NEG

X_POS

public static final Face X_POS

Field Detail

VALUES

public static final Face[] VALUES

All possible enum values for quick indexing.

OPPOSITES

public static final Face[] OPPOSITES

Mapping faces to their opposites (by ordinal()).

Method Detail

values

public static Face[] 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 (Face c : Face.values())
    System.out.println(c);

Returns:

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

valueOf

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

getOpposite

public Face getOpposite()

The the opposite face to this one.

Returns:

the opposite port.

See Also:

OPPOSITES

fromEnumFacing

public static Face fromEnumFacing(net.minecraft.util.EnumFacing facing)

Convert a facing from Forge's format to our internal format.

Parameters:

facing - the facing to convert.

Returns:

the Face representing that facing.

toEnumFacing

public static net.minecraft.util.EnumFacing toEnumFacing(Face face)

Convert a facing from our internal format to Forge's format.

Parameters:

face - the face to convert.

Returns:

the EnumFacing representing that facing.