Package cn.nukkit.math

Enum Class CompassRoseDirection

java.lang.Object

java.lang.Enum<CompassRoseDirection>

cn.nukkit.math.CompassRoseDirection

All Implemented Interfaces:

Serializable, Comparable<CompassRoseDirection>, Constable

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public enum CompassRoseDirection
extends Enum<CompassRoseDirection>

Represents a 16 direction compass rose.

https://en.wikipedia.org/wiki/Compass_rose#/media/File:Brosen_windrose.svg

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CompassRoseDirection.Precision

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST
EAST_NORTH_EAST
EAST_SOUTH_EAST
NORTH
NORTH_EAST
NORTH_NORTH_EAST
NORTH_NORTH_WEST
NORTH_WEST
SOUTH
SOUTH_EAST
SOUTH_SOUTH_EAST
SOUTH_SOUTH_WEST
SOUTH_WEST
WEST
WEST_NORTH_WEST
WEST_SOUTH_WEST

Method Summary

Modifier and Type	Method	Description
BlockFace	getClosestBlockFace()	Gets the closest face for this direction.
static CompassRoseDirection	getClosestFromYaw(double yaw)	Gets the closes direction based on the given Entity yaw.
static CompassRoseDirection	getClosestFromYaw(double yaw, CompassRoseDirection.Precision precision)	Gets the closes direction based on the given Entity yaw.
int	getModX()	Get the amount of X-coordinates to modify to get the represented block
int	getModZ()	Get the amount of Z-coordinates to modify to get the represented block
CompassRoseDirection	getOppositeFace()
float	getYaw()	Gets the Entity yaw that represents this direction.
static CompassRoseDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompassRoseDirection[]	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

NORTH

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection NORTH

EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection EAST

SOUTH

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection SOUTH

WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection WEST

NORTH_EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection NORTH_EAST

NORTH_WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection NORTH_WEST

SOUTH_EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection SOUTH_EAST

SOUTH_WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection SOUTH_WEST

WEST_NORTH_WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection WEST_NORTH_WEST

NORTH_NORTH_WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection NORTH_NORTH_WEST

NORTH_NORTH_EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection NORTH_NORTH_EAST

EAST_NORTH_EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection EAST_NORTH_EAST

EAST_SOUTH_EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection EAST_SOUTH_EAST

SOUTH_SOUTH_EAST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection SOUTH_SOUTH_EAST

SOUTH_SOUTH_WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection SOUTH_SOUTH_WEST

WEST_SOUTH_WEST

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CompassRoseDirection WEST_SOUTH_WEST

Method Details

values

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

getModX

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public int getModX()

Get the amount of X-coordinates to modify to get the represented block

Returns:

Amount of X-coordinates to modify

getModZ

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public int getModZ()

Get the amount of Z-coordinates to modify to get the represented block

Returns:

Amount of Z-coordinates to modify

getClosestBlockFace

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public BlockFace getClosestBlockFace()

Gets the closest face for this direction. For example, NNE returns N. Even directions like NE will return the direction to the left, N in this case.

getClosestFromYaw

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static CompassRoseDirection getClosestFromYaw(double yaw,
 @NotNull
 CompassRoseDirection.Precision precision)

Gets the closes direction based on the given Entity yaw.

Parameters:

yaw - An entity yaw

Returns:

The closest direction

Since:

1.4.0.0-PN

getClosestFromYaw

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static CompassRoseDirection getClosestFromYaw(double yaw)

Gets the closes direction based on the given Entity yaw.

Parameters:

yaw - An entity yaw

Returns:

The closest direction

Since:

1.4.0.0-PN

getOppositeFace

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public CompassRoseDirection getOppositeFace()

getYaw

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public float getYaw()

Gets the Entity yaw that represents this direction.

Returns:

The yaw value that can be used by entities to look at this direction.

Since:

1.4.0.0-PN