ForgeDirection (Forge API)

java.lang.Object
- java.lang.Enum<ForgeDirection>
- - net.minecraftforge.common.util.ForgeDirection

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ForgeDirection>
```
public enum ForgeDirection
extends java.lang.Enum<ForgeDirection>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description

DOWN
-Y

EAST
+X

NORTH
-Z

SOUTH
+Z

UNKNOWN
Used only by getOrientation, for invalid inputs

UP
+Y

WEST
-X

Enum Constants
Enum Constant and Description
`DOWN` -Y
`EAST` +X
`NORTH` -Z
`SOUTH` +Z
`UNKNOWN` Used only by getOrientation, for invalid inputs
`UP` +Y
`WEST` -X

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`flag`
`int`	`offsetX`
`int`	`offsetY`
`int`	`offsetZ`
`static int[]`	`OPPOSITES`
`static int[][]`	`ROTATION_MATRIX`
`static ForgeDirection[]`	`VALID_DIRECTIONS`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ForgeDirection`	`getOpposite()`
`static ForgeDirection`	`getOrientation(int id)`
`ForgeDirection`	`getRotation(ForgeDirection axis)`
`static ForgeDirection`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static ForgeDirection[]`	`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
  - DOWN
```
public static final ForgeDirection DOWN
```
    -Y
  - UP
```
public static final ForgeDirection UP
```
    +Y
  - NORTH
```
public static final ForgeDirection NORTH
```
    -Z
  - SOUTH
```
public static final ForgeDirection SOUTH
```
    +Z
  - WEST
```
public static final ForgeDirection WEST
```
    -X
  - EAST
```
public static final ForgeDirection EAST
```
    +X
  - UNKNOWN
```
public static final ForgeDirection UNKNOWN
```
    Used only by getOrientation, for invalid inputs
- Field Detail
  - offsetX
```
public final int offsetX
```
  - offsetY
```
public final int offsetY
```
  - offsetZ
```
public final int offsetZ
```
  - flag
```
public final int flag
```
  - VALID_DIRECTIONS
```
public static final ForgeDirection[] VALID_DIRECTIONS
```
  - OPPOSITES
```
public static final int[] OPPOSITES
```
  - ROTATION_MATRIX
```
public static final int[][] ROTATION_MATRIX
```
- Method Detail
  - values
```
public static ForgeDirection[] 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 (ForgeDirection c : ForgeDirection.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ForgeDirection 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
  - getOrientation
```
public static ForgeDirection getOrientation(int id)
```
  - getOpposite
```
public ForgeDirection getOpposite()
```
  - getRotation
```
public ForgeDirection getRotation(ForgeDirection axis)
```

Enum ForgeDirection

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DOWN

UP

NORTH

SOUTH

WEST

EAST

UNKNOWN

Field Detail

offsetX

offsetY

offsetZ

flag

VALID_DIRECTIONS

OPPOSITES

ROTATION_MATRIX

Method Detail

values

valueOf

getOrientation

getOpposite

getRotation