Package org.bukkit.block
Enum Class BlockFace
- All Implemented Interfaces:
Serializable
,Comparable<BlockFace>
,Constable
Represents the face of a block
-
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 normal vector corresponding to this block face.int
getModX()
Get the amount of X-coordinates to modify to get the represented blockint
getModY()
Get the amount of Y-coordinates to modify to get the represented blockint
getModZ()
Get the amount of Z-coordinates to modify to get the represented blockboolean
Returns true if this face is aligned with one of the unit axes in 3D Cartesian space (ie NORTH, SOUTH, EAST, WEST, UP, DOWN).static BlockFace
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.
-
Enum Constant Details
-
NORTH
-
EAST
-
SOUTH
-
WEST
-
UP
-
DOWN
-
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
-
SELF
-
-
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
public int getModX()Get the amount of X-coordinates to modify to get the represented block- Returns:
- Amount of X-coordinates to modify
-
getModY
public int getModY()Get the amount of Y-coordinates to modify to get the represented block- Returns:
- Amount of Y-coordinates to modify
-
getModZ
public int getModZ()Get the amount of Z-coordinates to modify to get the represented block- Returns:
- Amount of Z-coordinates to modify
-
getDirection
Gets the normal vector corresponding to this block face.- Returns:
- the normal vector
-
isCartesian
public boolean isCartesian()Returns true if this face is aligned with one of the unit axes in 3D Cartesian space (ie NORTH, SOUTH, EAST, WEST, UP, DOWN).- Returns:
- Cartesian status
-
getOppositeFace
-