Enum BlockFace

java.lang.Object
java.lang.Enum<BlockFace>
org.bukkit.block.BlockFace
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BlockFace>, java.lang.constant.Constable

public enum BlockFace
extends java.lang.Enum<BlockFace>
Represents the face of a block
  • Enum Constant Details

  • Method Details

    • values

      public static BlockFace[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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()