Package cn.nukkit.math
Enum Class 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/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the closest face for this direction.static CompassRoseDirection
getClosestFromYaw
(double yaw) Gets the closes direction based on the givenEntity
yaw.static CompassRoseDirection
getClosestFromYaw
(double yaw, CompassRoseDirection.Precision precision) Gets the closes direction based on the givenEntity
yaw.int
getModX()
Get the amount of X-coordinates to modify to get the represented blockint
getModZ()
Get the amount of Z-coordinates to modify to get the represented blockfloat
getYaw()
Gets theEntity
yaw that represents this direction.static CompassRoseDirection
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.
-
Enum Constant Details
-
NORTH
-
EAST
-
SOUTH
-
WEST
-
NORTH_EAST
-
NORTH_WEST
-
SOUTH_EAST
-
SOUTH_WEST
-
WEST_NORTH_WEST
-
NORTH_NORTH_WEST
-
NORTH_NORTH_EAST
-
EAST_NORTH_EAST
-
EAST_SOUTH_EAST
-
SOUTH_SOUTH_EAST
-
SOUTH_SOUTH_WEST
-
WEST_SOUTH_WEST
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getModX
Get the amount of X-coordinates to modify to get the represented block- Returns:
- Amount of X-coordinates to modify
-
getModZ
Get the amount of Z-coordinates to modify to get the represented block- Returns:
- Amount of Z-coordinates to modify
-
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, @Nonnull CompassRoseDirection.Precision precision) Gets the closes direction based on the givenEntity
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 givenEntity
yaw.- Parameters:
yaw
- An entity yaw- Returns:
- The closest direction
- Since:
- 1.4.0.0-PN
-
getOppositeFace
-
getYaw
Gets theEntity
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
-