Direction (forge 1.15.2-31.2.47)

java.lang.Object
- java.lang.Enum<Direction>
- - net.minecraft.util.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>, IStringSerializable
```
public enum Direction
extends java.lang.Enum<Direction>
implements IStringSerializable
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Direction.Axis

static class Direction.AxisDirection

static class Direction.Plane

Nested Classes
Modifier and Type	Class and Description
`static class`	`Direction.Axis`
`static class`	`Direction.AxisDirection`
`static class`	`Direction.Plane`

Enum Constant Summary

Enum Constants
Enum Constant and Description

DOWN

EAST

NORTH

SOUTH

UP

WEST

Enum Constants
Enum Constant and Description
`DOWN`
`EAST`
`NORTH`
`SOUTH`
`UP`
`WEST`

Field Summary

Fields
Modifier and Type	Field and Description
`private Direction.Axis`	`axis`
`private Direction.AxisDirection`	`axisDirection`
`private static Direction[]`	`BY_HORIZONTAL_INDEX`
`private static Direction[]`	`BY_INDEX`
`private static it.unimi.dsi.fastutil.longs.Long2ObjectMap<Direction>`	`BY_LONG`
`private Vec3i`	`directionVec`
`private int`	`horizontalIndex`
`private int`	`index`
`private java.lang.String`	`name`
`private static java.util.Map<java.lang.String,Direction>`	`NAME_LOOKUP`
`private int`	`opposite`
`private static Direction[]`	`VALUES`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Direction`	`byHorizontalIndex(int horizontalIndexIn)`
`static Direction`	`byIndex(int index)`
`static Direction`	`byLong(int x, int y, int z)`
`static Direction`	`byName(java.lang.String name)`
`private static Direction[]`	`compose(Direction first, Direction second, Direction third)`
`static Direction`	`fromAngle(double angle)`
`Direction.Axis`	`getAxis()`
`Direction.AxisDirection`	`getAxisDirection()`
`Vec3i`	`getDirectionVec()`
`static Direction[]`	`getFacingDirections(Entity entityIn)`
`static Direction`	`getFacingFromAxis(Direction.AxisDirection axisDirectionIn, Direction.Axis axisIn)`
`static Direction`	`getFacingFromAxisDirection(Direction.Axis axisIn, Direction.AxisDirection axisDirectionIn)`
`static Direction`	`getFacingFromVector(double x, double y, double z)`
`static Direction`	`getFacingFromVector(float x, float y, float z)`
`float`	`getHorizontalAngle()`
`int`	`getHorizontalIndex()`
`int`	`getIndex()`
`java.lang.String`	`getName()`
`java.lang.String`	`getName2()`
`Direction`	`getOpposite()`
`Quaternion`	`getRotation()`
`int`	`getXOffset()`
`int`	`getYOffset()`
`int`	`getZOffset()`
`static Direction`	`random(java.util.Random rand)`
`static Direction`	`rotateFace(Matrix4f matrixIn, Direction directionIn)`
`Direction`	`rotateY()`
`Direction`	`rotateYCCW()`
`java.lang.String`	`toString()`
`Vector3f`	`toVector3f()`
`static Direction`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Direction[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOWN
```
public static final Direction DOWN
```

UP
```
public static final Direction UP
```

NORTH
```
public static final Direction NORTH
```

SOUTH
```
public static final Direction SOUTH
```

WEST
```
public static final Direction WEST
```

EAST
```
public static final Direction EAST
```

Field Detail

index
```
private final int index
```

opposite
```
private final int opposite
```

horizontalIndex
```
private final int horizontalIndex
```

name
```
private final java.lang.String name
```

axis
```
private final Direction.Axis axis
```

axisDirection

private final Direction.AxisDirection axisDirection

directionVec
```
private final Vec3i directionVec
```

VALUES

private static final Direction[] VALUES

NAME_LOOKUP

private static final java.util.Map<java.lang.String,Direction> NAME_LOOKUP

BY_INDEX

private static final Direction[] BY_INDEX

BY_HORIZONTAL_INDEX

private static final Direction[] BY_HORIZONTAL_INDEX

BY_LONG

private static final it.unimi.dsi.fastutil.longs.Long2ObjectMap<Direction> BY_LONG

Method Detail

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

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

valueOf
```
public static Direction 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

getFacingDirections

public static Direction[] getFacingDirections(Entity entityIn)

compose

private static Direction[] compose(Direction first,
                                   Direction second,
                                   Direction third)

rotateFace

public static Direction rotateFace(Matrix4f matrixIn,
                                   Direction directionIn)

getRotation
```
public Quaternion getRotation()
```

getIndex
```
public int getIndex()
```

getHorizontalIndex
```
public int getHorizontalIndex()
```

getAxisDirection

public Direction.AxisDirection getAxisDirection()

getOpposite
```
public Direction getOpposite()
```

rotateY
```
public Direction rotateY()
```

rotateYCCW
```
public Direction rotateYCCW()
```

getXOffset
```
public int getXOffset()
```

getYOffset
```
public int getYOffset()
```

getZOffset
```
public int getZOffset()
```

toVector3f
```
public Vector3f toVector3f()
```

getName2
```
public java.lang.String getName2()
```

getAxis
```
public Direction.Axis getAxis()
```

byName

@Nullable
public static Direction byName(@Nullable
                                         java.lang.String name)

byIndex

public static Direction byIndex(int index)

byHorizontalIndex

public static Direction byHorizontalIndex(int horizontalIndexIn)

byLong

@Nullable
public static Direction byLong(int x,
                                         int y,
                                         int z)

fromAngle

public static Direction fromAngle(double angle)

getFacingFromAxisDirection

public static Direction getFacingFromAxisDirection(Direction.Axis axisIn,
                                                   Direction.AxisDirection axisDirectionIn)

getHorizontalAngle
```
public float getHorizontalAngle()
```

random

public static Direction random(java.util.Random rand)

getFacingFromVector

public static Direction getFacingFromVector(double x,
                                            double y,
                                            double z)

getFacingFromVector

public static Direction getFacingFromVector(float x,
                                            float y,
                                            float z)

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Enum<Direction>

getName
```
public java.lang.String getName()
```
Specified by:

getName in interface IStringSerializable

getFacingFromAxis

public static Direction getFacingFromAxis(Direction.AxisDirection axisDirectionIn,
                                          Direction.Axis axisIn)

getDirectionVec
```
public Vec3i getDirectionVec()
```

Enum Direction

Nested Class Summary

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

Field Detail

index

opposite

horizontalIndex

name

axis

axisDirection

directionVec

VALUES

NAME_LOOKUP

BY_INDEX

BY_HORIZONTAL_INDEX

BY_LONG

Method Detail

values

valueOf

getFacingDirections

compose

rotateFace

getRotation

getIndex

getHorizontalIndex

getAxisDirection

getOpposite

rotateY

rotateYCCW

getXOffset

getYOffset

getZOffset

toVector3f

getName2

getAxis

byName

byIndex

byHorizontalIndex

byLong

fromAngle

getFacingFromAxisDirection

getHorizontalAngle

random

getFacingFromVector

getFacingFromVector

toString

getName

getFacingFromAxis

getDirectionVec