Package org.bukkit.material

Class Door

java.lang.Object
org.bukkit.material.MaterialData
org.bukkit.material.Door
All Implemented Interfaces:
Cloneable, Directional, Openable
@Deprecated(forRemoval=true, since="1.13") public class Door extends MaterialData implements Directional, Openable
Deprecated, for removal: This API element is subject to removal in a future version.
all usage of MaterialData is deprecated and subject to removal. Use BlockData.
Represents a door. This class was previously deprecated, but has been retrofitted to work with modern doors. Some methods are undefined dependant on isTopHalf() due to Minecraft's internal representation of doors.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Door()
    Deprecated.
    Artifact of old API, equivalent to new Door(Material.LEGACY_WOODEN_DOOR);
    Door(Material type)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Door(Material type, boolean isHingeRight)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs the top half of door of the given material type and with the hinge on the left or right
    Door(Material type, byte data)
    Deprecated.
    Magic value
    Door(Material type, BlockFace face)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs the bottom half of a door of the given material type, facing the specified direction and set to closed
    Door(Material type, BlockFace face, boolean isOpen)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs the bottom half of a door of the given material type, facing the specified direction and set to open or closed
    Door(TreeSpecies species, boolean isHingeRight)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs the top half of a wooden door of the given species and with the hinge on the left or right
    Door(TreeSpecies species, BlockFace face)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to closed
    Door(TreeSpecies species, BlockFace face, boolean isOpen)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to open or closed

  • Method Summary

    Modifier and Type
    Method
    Description
    Door
    clone()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    BlockFace
    getFacing()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the direction that this door is facing.
    boolean
    getHinge()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the side of the door the hinge is on.
    BlockFace
    getHingeCorner()
    Deprecated.
    This method should not be used; use hinge and facing accessors instead.
    static Material
    getWoodDoorOfSpecies(TreeSpecies species)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the item type of a wooden door for the given tree species.
    boolean
    isOpen()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Result is undefined if isTopHalf() is true.
    boolean
    isTopHalf()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setFacingDirection(BlockFace face)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the direction that this door should is facing.
    void
    setHinge(boolean isHingeRight)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether the hinge is on the left or right side.
    void
    setOpen(boolean isOpen)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set whether the door is open.
    void
    setTopHalf(boolean isTopHalf)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Configure this part of the door to be either the top or the bottom half
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class org.bukkit.material.MaterialData

    equals, getData, getItemType, hashCode, setData, toItemStack, toItemStack

    Methods inherited from class java.lang.Object

    finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

  • Method Details

    • getWoodDoorOfSpecies

      public static Material getWoodDoorOfSpecies(TreeSpecies species)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the item type of a wooden door for the given tree species.
      Parameters:
      species - The species of wood door required.
      Returns:
      The item type for the given species.
      See Also:

    • isOpen

      public boolean isOpen()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Result is undefined if isTopHalf() is true.
      Specified by:
      isOpen in interface Openable
      Returns:
      true if the door has swung counterclockwise around its hinge.

    • setOpen

      public void setOpen(boolean isOpen)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether the door is open. Undefined if isTopHalf() is true.
      Specified by:
      setOpen in interface Openable
      Parameters:
      isOpen - True to open the door.

    • isTopHalf

      public boolean isTopHalf()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      whether this is the top half of the door

    • setTopHalf

      public void setTopHalf(boolean isTopHalf)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Configure this part of the door to be either the top or the bottom half
      Parameters:
      isTopHalf - True to make it the top half.

    • getHingeCorner

      @Deprecated public BlockFace getHingeCorner()
      Deprecated.
      This method should not be used; use hinge and facing accessors instead.
      Returns:
      BlockFace.SELF

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class MaterialData

    • setFacingDirection

      public void setFacingDirection(BlockFace face)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set the direction that this door should is facing. Undefined if isTopHalf() is true.
      Specified by:
      setFacingDirection in interface Directional
      Parameters:
      face - the direction

    • getFacing

      public BlockFace getFacing()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the direction that this door is facing. Undefined if isTopHalf() is true.
      Specified by:
      getFacing in interface Directional
      Returns:
      the direction

    • getHinge

      public boolean getHinge()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the side of the door the hinge is on. Undefined if isTopHalf() is false.
      Returns:
      false for left hinge, true for right hinge

    • setHinge

      public void setHinge(boolean isHingeRight)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set whether the hinge is on the left or right side. Left is false, right is true. Undefined if isTopHalf() is false.
      Parameters:
      isHingeRight - True if the hinge is on the right hand side, false if the hinge is on the left hand side.

    • clone

      public Door clone()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      clone in class MaterialData