BlockFace (Spigot-API 1.13-R0.1-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<BlockFace>
- - org.bukkit.block.BlockFace

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BlockFace>
```
public enum BlockFace
extends java.lang.Enum<BlockFace>
```
Represents the face of a block

Enum Constant Summary

Enum Constants
Enum Constant	Description
`DOWN`
`EAST`
`EAST_NORTH_EAST`
`EAST_SOUTH_EAST`
`NORTH`
`NORTH_EAST`
`NORTH_NORTH_EAST`
`NORTH_NORTH_WEST`
`NORTH_WEST`
`SELF`
`SOUTH`
`SOUTH_EAST`
`SOUTH_SOUTH_EAST`
`SOUTH_SOUTH_WEST`
`SOUTH_WEST`
`UP`
`WEST`
`WEST_NORTH_WEST`
`WEST_SOUTH_WEST`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getModX()`	Get the amount of X-coordinates to modify to get the represented block
`int`	`getModY()`	Get the amount of Y-coordinates to modify to get the represented block
`int`	`getModZ()`	Get the amount of Z-coordinates to modify to get the represented block
`BlockFace`	`getOppositeFace()`
`static BlockFace`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static BlockFace[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NORTH
```
public static final BlockFace NORTH
```
  - EAST
```
public static final BlockFace EAST
```
  - SOUTH
```
public static final BlockFace SOUTH
```
  - WEST
```
public static final BlockFace WEST
```
  - UP
```
public static final BlockFace UP
```
  - DOWN
```
public static final BlockFace DOWN
```
  - NORTH_EAST
```
public static final BlockFace NORTH_EAST
```
  - NORTH_WEST
```
public static final BlockFace NORTH_WEST
```
  - SOUTH_EAST
```
public static final BlockFace SOUTH_EAST
```
  - SOUTH_WEST
```
public static final BlockFace SOUTH_WEST
```
  - WEST_NORTH_WEST
```
public static final BlockFace WEST_NORTH_WEST
```
  - NORTH_NORTH_WEST
```
public static final BlockFace NORTH_NORTH_WEST
```
  - NORTH_NORTH_EAST
```
public static final BlockFace NORTH_NORTH_EAST
```
  - EAST_NORTH_EAST
```
public static final BlockFace EAST_NORTH_EAST
```
  - EAST_SOUTH_EAST
```
public static final BlockFace EAST_SOUTH_EAST
```
  - SOUTH_SOUTH_EAST
```
public static final BlockFace SOUTH_SOUTH_EAST
```
  - SOUTH_SOUTH_WEST
```
public static final BlockFace SOUTH_SOUTH_WEST
```
  - WEST_SOUTH_WEST
```
public static final BlockFace WEST_SOUTH_WEST
```
  - SELF
```
public static final BlockFace SELF
```
- Method Detail
  - values
```
public static BlockFace[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (BlockFace c : BlockFace.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BlockFace valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - 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
  - getOppositeFace
```
public BlockFace getOppositeFace()
```

Enum BlockFace

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

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 Detail

values

valueOf

getModX

getModY

getModZ

getOppositeFace