org.bukkit.material

Class Door

java.lang.Object

org.bukkit.material.MaterialData

org.bukkit.material.Door

All Implemented Interfaces:

Cloneable, Directional, Openable

public class Door
extends MaterialData
implements Directional, Openable

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.

Constructor Summary

Constructors

Constructor and Description
Door() Deprecated. Artifact of old API, equivalent to new Door(Material.WOODEN_DOOR);
Door(int type) Deprecated. Magic value
Door(int type, byte data) Deprecated. Magic value
Door(Material type)
Door(Material type, byte data) Deprecated. Magic value

Method Summary

Methods

Modifier and Type	Method and Description
Door	clone()
BlockFace	getFacing() Get the direction that this door is facing.
boolean	getHinge() 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.
boolean	isOpen() Result is undefined if isTopHalf() is true.
boolean	isTopHalf()
void	setFacingDirection(BlockFace face) Set the direction that this door should is facing.
void	setHinge(boolean hinge) Set whether the hinge is on the left or right side.
void	setOpen(boolean isOpen) Set whether the door is open.
void	setTopHalf(boolean isTopHalf) Configure this part of the door to be either the top or the bottom half
String	toString()

Methods inherited from class org.bukkit.material.MaterialData

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Door

@Deprecated
public Door()

Deprecated. Artifact of old API, equivalent to new Door(Material.WOODEN_DOOR);

Door

@Deprecated
public Door(int type)

Deprecated. Magic value

Parameters:

type - the raw type id

Door

public Door(Material type)

Door

@Deprecated
public Door(int type,
               byte data)

Deprecated. Magic value

Parameters:

type - the raw type id

data - the raw data value

Door

@Deprecated
public Door(Material type,
               byte data)

Deprecated. Magic value

Parameters:

type - the type

data - the raw data value

Method Detail

isOpen

public boolean isOpen()

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)

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()

Returns:

whether this is the top half of the door

setTopHalf

public void setTopHalf(boolean isTopHalf)

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()

Overrides:

toString in class MaterialData

setFacingDirection

public void setFacingDirection(BlockFace face)

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()

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()

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 hinge)

Set whether the hinge is on the left or right side. Left is false, right is true. Undefined if isTopHalf() is false.

clone

public Door clone()

Overrides:

clone in class MaterialData