Package com.github.retrooper.packetevents.protocol.world

Enum Class BlockFace

java.lang.Object

java.lang.Enum<BlockFace>

com.github.retrooper.packetevents.protocol.world.BlockFace

All Implemented Interfaces:

Serializable, Comparable<BlockFace>, Constable

public enum BlockFace
extends Enum<BlockFace>

The BlockFace enum contains constants for the different valid faces in the minecraft protocol.

Since:

1.7.8

See Also:

• https://wiki.vg/Protocol#Player_Digging

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN	-Y offset
EAST	+X offset
NORTH	-Z offset
OTHER	Face is set to 255
SOUTH	+Z offset
UP	+Y offset
WEST	-X offset

Method Summary

Modifier and Type	Method	Description
static BlockFace	getBlockFaceByValue(int face)
BlockFace	getCCW()
BlockFace	getCW()
short	getFaceValue()
static BlockFace	getLegacyBlockFaceByValue(int face)
int	getModX()
int	getModY()
int	getModZ()
BlockFace	getOppositeFace()
static BlockFace	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlockFace[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DOWN

public static final BlockFace DOWN

-Y offset

UP

public static final BlockFace UP

+Y offset

NORTH

public static final BlockFace NORTH

-Z offset

SOUTH

public static final BlockFace SOUTH

+Z offset

WEST

public static final BlockFace WEST

-X offset

EAST

public static final BlockFace EAST

+X offset

OTHER

public static final BlockFace OTHER

Face is set to 255

Method Details

values

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

getLegacyBlockFaceByValue

public static BlockFace getLegacyBlockFaceByValue(int face)

getBlockFaceByValue

public static BlockFace getBlockFaceByValue(int face)

getModX

public int getModX()

getModY

public int getModY()

getModZ

public int getModZ()

getOppositeFace

public BlockFace getOppositeFace()

getCCW

public BlockFace getCCW()

getCW

public BlockFace getCW()

getFaceValue

public short getFaceValue()