Enum Direction 

pub(in worldgen::feature) enum Direction {
    Down,
    Up,
    North,
    South,
    West,
    East,
}

The six cardinal directions in Minecraft.

Variants

Down

Negative Y direction.

Up

Positive Y direction.

North

Negative Z direction.

South

Positive Z direction.

West

Negative X direction.

East

Positive X direction.

Implementations

impl Direction

pub const UPDATE_SHAPE_ORDER: [Direction; 6]

The order in which neighbor shape updates are processed. This matches vanilla’s BlockBehavior.UPDATE_SHAPE_ORDER.

pub const FLOW_NEIGHBOR_CHECK: [Direction; 5]

Vanilla: LiquidBlock.POSSIBLE_FLOW_DIRECTIONS mapped through getOpposite(). Used by LiquidBlock.shouldSpreadLiquid() to check neighbors for lava-water interactions.

pub const HORIZONTAL: [Direction; 4]

Vanilla Direction.Plane.HORIZONTAL order.

pub const ALL: [Direction; 6]

Vanilla Direction.values() order.

pub const fn offset(self) -> (i32, i32, i32)

Returns the block position offset for this direction.

pub const fn offset_xz(self) -> (i32, i32)

Returns the XZ offset for this direction, treating the vertical directions as no movement.

For Down and Up the result is (0, 0).

pub const fn offset_vec(self) -> IVec3

Returns the block position offset for this direction as an IVec3.

pub fn relative(self, pos: BlockPos) -> BlockPos

Returns the block position relative to the given position in this direction.

pub const fn get_axis(self) -> Axis

Returns the axis this direction is on.

pub const fn opposite(self) -> Direction

Returns the opposite direction.

pub fn from_yaw(yaw: f32) -> Direction

Returns the horizontal direction from a yaw rotation.

Yaw values follow Minecraft’s convention:

• 0° = South (+Z)
• 90° = West (-X)
• 180° = North (-Z)
• 270° = East (+X)

pub const fn to_yaw(self) -> f32

Returns the yaw rotation for this direction.

Only meaningful for horizontal directions. Vertical directions return 0.

pub const fn axis(self) -> Axis

Returns the axis this direction is on.

pub const fn positive_for_axis(axis: Axis) -> Direction

Returns vanilla Direction.get(AxisDirection.POSITIVE, axis).

pub const fn is_horizontal(self) -> bool

Returns whether this direction is horizontal (not up or down).

pub const fn rotate_y_clockwise(self) -> Direction

Rotates this direction 90 degrees clockwise around the Y axis.

Vertical directions are unchanged.

pub const fn rotate_y_counter_clockwise(self) -> Direction

Rotates this direction 90 degrees counter-clockwise around the Y axis.

Vertical directions are unchanged.

pub fn ordered_by_nearest(yaw: f32, pitch: f32) -> [Direction; 6]

Returns all directions ordered by how closely they match the player’s look direction.

This matches vanilla’s Direction.orderedByNearest(Entity).

• yaw: Player’s yaw rotation in degrees (0 = South, 90 = West, 180 = North, 270 = East)
• pitch: Player’s pitch rotation in degrees (negative = looking up, positive = looking down)

pub const fn as_str(&self) -> &str

Returns the direction name as a string (for PropertyEnum compatibility).

pub fn random() -> Direction

Returns a random direction

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Direction

impl Debug for Direction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for Direction

fn eq(&self, other: &Direction) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PropertyEnum for Direction

fn as_str(&self) -> &str

impl ReadFrom for Direction

fn read(data: &mut Cursor<&[u8]>) -> Result<Direction, Error>

Reads data from a cursor.

impl StructuralPartialEq for Direction