Scissors-Website/public/javadoc/1.17.1/org/bukkit/material/Door.html
2022-07-05 18:33:56 -05:00

670 lines
45 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Door (Scissors-API 1.17.1-R0.1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.bukkit.material, class: Door">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.bukkit.material</a></div>
<h1 title="Class Door" class="title">Class Door</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="MaterialData.html" title="class in org.bukkit.material">org.bukkit.material.MaterialData</a>
<div class="inheritance">org.bukkit.material.Door</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="Directional.html" title="interface in org.bukkit.material">Directional</a></code>, <code><a href="Openable.html" title="interface in org.bukkit.material">Openable</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public class </span><span class="element-name type-name-label">Door</span>
<span class="extends-implements">extends <a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a>
implements <a href="Directional.html" title="interface in org.bukkit.material">Directional</a>, <a href="Openable.html" title="interface in org.bukkit.material">Openable</a></span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">all usage of MaterialData is deprecated and subject to removal.
Use <a href="../block/data/BlockData.html" title="interface in org.bukkit.block.data"><code>BlockData</code></a>.</div>
</div>
<div class="block">Represents a door.
This class was previously deprecated, but has been retrofitted to
work with modern doors. Some methods are undefined dependant on <code>isTopHalf()</code>
due to Minecraft's internal representation of doors.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_WOODEN_DOOR"><code>Material.LEGACY_WOODEN_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_IRON_DOOR_BLOCK"><code>Material.LEGACY_IRON_DOOR_BLOCK</code></a></li>
<li><a href="../Material.html#LEGACY_SPRUCE_DOOR"><code>Material.LEGACY_SPRUCE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_BIRCH_DOOR"><code>Material.LEGACY_BIRCH_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_JUNGLE_DOOR"><code>Material.LEGACY_JUNGLE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_ACACIA_DOOR"><code>Material.LEGACY_ACACIA_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_DARK_OAK_DOOR"><code>Material.LEGACY_DARK_OAK_DOOR</code></a></li>
</ul>
</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Door</a>()</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Artifact of old API, equivalent to new <code>Door(Material.LEGACY_WOODEN_DOOR);</code></div>
</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material)" class="member-name-link">Door</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
&nbsp;</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,boolean)" class="member-name-link">Door</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
boolean&nbsp;isHingeRight)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the top half of door of the given material type and with the hinge on the left or right</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,byte)" class="member-name-link">Door</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
byte&nbsp;data)</code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Magic value</div>
</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,org.bukkit.block.BlockFace)" class="member-name-link">Door</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a door of the given material type, facing the specified direction and set to closed</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.Material,org.bukkit.block.BlockFace,boolean)" class="member-name-link">Door</a><wbr>(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
boolean&nbsp;isOpen)</code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a door of the given material type, facing the specified direction and set to open
or closed</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.TreeSpecies,boolean)" class="member-name-link">Door</a><wbr>(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species,
boolean&nbsp;isHingeRight)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the top half of a wooden door of the given species and with the hinge on the left or right</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.bukkit.TreeSpecies,org.bukkit.block.BlockFace)" class="member-name-link">Door</a><wbr>(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</code></div>
<div class="col-last odd-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to
closed</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.TreeSpecies,org.bukkit.block.BlockFace,boolean)" class="member-name-link">Door</a><wbr>(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
boolean&nbsp;isOpen)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to open
or closed</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="Door.html" title="class in org.bukkit.material">Door</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getFacing()" class="member-name-link">getFacing</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Get the direction that this door is facing.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getHinge()" class="member-name-link">getHinge</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns the side of the door the hinge is on.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getHingeCorner()" class="member-name-link">getHingeCorner</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">This method should not be used; use hinge and facing accessors instead.</div>
</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="../Material.html" title="enum class in org.bukkit">Material</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getWoodDoorOfSpecies(org.bukkit.TreeSpecies)" class="member-name-link">getWoodDoorOfSpecies</a><wbr>(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns the item type of a wooden door for the given tree species.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isOpen()" class="member-name-link">isOpen</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Result is undefined if <code>isTopHalf()</code> is true.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isTopHalf()" class="member-name-link">isTopHalf</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setFacingDirection(org.bukkit.block.BlockFace)" class="member-name-link">setFacingDirection</a><wbr>(<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Set the direction that this door should is facing.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setHinge(boolean)" class="member-name-link">setHinge</a><wbr>(boolean&nbsp;isHingeRight)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Set whether the hinge is on the left or right side.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setOpen(boolean)" class="member-name-link">setOpen</a><wbr>(boolean&nbsp;isOpen)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Set whether the door is open.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setTopHalf(boolean)" class="member-name-link">setTopHalf</a><wbr>(boolean&nbsp;isTopHalf)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Configure this part of the door to be either the top or the bottom half</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
<div class="block"><span class="deprecated-label">Deprecated.</span></div>
&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.material.MaterialData">Methods inherited from class&nbsp;org.bukkit.material.<a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></h3>
<code><a href="MaterialData.html#equals(java.lang.Object)">equals</a>, <a href="MaterialData.html#getData()">getData</a>, <a href="MaterialData.html#getItemType()">getItemType</a>, <a href="MaterialData.html#hashCode()">hashCode</a>, <a href="MaterialData.html#setData(byte)">setData</a>, <a href="MaterialData.html#toItemStack()">toItemStack</a>, <a href="MaterialData.html#toItemStack(int)">toItemStack</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>Door</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Artifact of old API, equivalent to new <code>Door(Material.LEGACY_WOODEN_DOOR);</code></div>
</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,org.bukkit.block.BlockFace)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a door of the given material type, facing the specified direction and set to closed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - The type of material this door is made of. This must match the type of the block above.</dd>
<dd><code>face</code> - The direction the door is facing.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_WOODEN_DOOR"><code>Material.LEGACY_WOODEN_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_IRON_DOOR_BLOCK"><code>Material.LEGACY_IRON_DOOR_BLOCK</code></a></li>
<li><a href="../Material.html#LEGACY_SPRUCE_DOOR"><code>Material.LEGACY_SPRUCE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_BIRCH_DOOR"><code>Material.LEGACY_BIRCH_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_JUNGLE_DOOR"><code>Material.LEGACY_JUNGLE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_ACACIA_DOOR"><code>Material.LEGACY_ACACIA_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_DARK_OAK_DOOR"><code>Material.LEGACY_DARK_OAK_DOOR</code></a></li>
<li><a href="../block/BlockFace.html#WEST"><code>BlockFace.WEST</code></a></li>
<li><a href="../block/BlockFace.html#NORTH"><code>BlockFace.NORTH</code></a></li>
<li><a href="../block/BlockFace.html#EAST"><code>BlockFace.EAST</code></a></li>
<li><a href="../block/BlockFace.html#SOUTH"><code>BlockFace.SOUTH</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,org.bukkit.block.BlockFace,boolean)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
boolean&nbsp;isOpen)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a door of the given material type, facing the specified direction and set to open
or closed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - The type of material this door is made of. This must match the type of the block above.</dd>
<dd><code>face</code> - The direction the door is facing.</dd>
<dd><code>isOpen</code> - Whether the door is currently opened.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_WOODEN_DOOR"><code>Material.LEGACY_WOODEN_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_IRON_DOOR_BLOCK"><code>Material.LEGACY_IRON_DOOR_BLOCK</code></a></li>
<li><a href="../Material.html#LEGACY_SPRUCE_DOOR"><code>Material.LEGACY_SPRUCE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_BIRCH_DOOR"><code>Material.LEGACY_BIRCH_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_JUNGLE_DOOR"><code>Material.LEGACY_JUNGLE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_ACACIA_DOOR"><code>Material.LEGACY_ACACIA_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_DARK_OAK_DOOR"><code>Material.LEGACY_DARK_OAK_DOOR</code></a></li>
<li><a href="../block/BlockFace.html#WEST"><code>BlockFace.WEST</code></a></li>
<li><a href="../block/BlockFace.html#NORTH"><code>BlockFace.NORTH</code></a></li>
<li><a href="../block/BlockFace.html#EAST"><code>BlockFace.EAST</code></a></li>
<li><a href="../block/BlockFace.html#SOUTH"><code>BlockFace.SOUTH</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,boolean)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
boolean&nbsp;isHingeRight)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the top half of door of the given material type and with the hinge on the left or right</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - The type of material this door is made of. This must match the type of the block below.</dd>
<dd><code>isHingeRight</code> - True if the hinge is on the right hand side, false if the hinge is on the left hand side.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="../Material.html#LEGACY_WOODEN_DOOR"><code>Material.LEGACY_WOODEN_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_IRON_DOOR_BLOCK"><code>Material.LEGACY_IRON_DOOR_BLOCK</code></a></li>
<li><a href="../Material.html#LEGACY_SPRUCE_DOOR"><code>Material.LEGACY_SPRUCE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_BIRCH_DOOR"><code>Material.LEGACY_BIRCH_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_JUNGLE_DOOR"><code>Material.LEGACY_JUNGLE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_ACACIA_DOOR"><code>Material.LEGACY_ACACIA_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_DARK_OAK_DOOR"><code>Material.LEGACY_DARK_OAK_DOOR</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.TreeSpecies,org.bukkit.block.BlockFace)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to
closed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>species</code> - The species this wooden door is made of. This must match the species of the block above.</dd>
<dd><code>face</code> - The direction the door is facing.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../TreeSpecies.html" title="enum class in org.bukkit"><code>TreeSpecies</code></a></li>
<li><a href="../block/BlockFace.html#WEST"><code>BlockFace.WEST</code></a></li>
<li><a href="../block/BlockFace.html#NORTH"><code>BlockFace.NORTH</code></a></li>
<li><a href="../block/BlockFace.html#EAST"><code>BlockFace.EAST</code></a></li>
<li><a href="../block/BlockFace.html#SOUTH"><code>BlockFace.SOUTH</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.TreeSpecies,org.bukkit.block.BlockFace,boolean)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species,
<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face,
boolean&nbsp;isOpen)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the bottom half of a wooden door of the given species, facing the specified direction and set to open
or closed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>species</code> - The species this wooden door is made of. This must match the species of the block above.</dd>
<dd><code>face</code> - The direction the door is facing.</dd>
<dd><code>isOpen</code> - Whether the door is currently opened.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../TreeSpecies.html" title="enum class in org.bukkit"><code>TreeSpecies</code></a></li>
<li><a href="../block/BlockFace.html#WEST"><code>BlockFace.WEST</code></a></li>
<li><a href="../block/BlockFace.html#NORTH"><code>BlockFace.NORTH</code></a></li>
<li><a href="../block/BlockFace.html#EAST"><code>BlockFace.EAST</code></a></li>
<li><a href="../block/BlockFace.html#SOUTH"><code>BlockFace.SOUTH</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.TreeSpecies,boolean)">
<h3>Door</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species,
boolean&nbsp;isHingeRight)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Constructs the top half of a wooden door of the given species and with the hinge on the left or right</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>species</code> - The species this wooden door is made of. This must match the species of the block below.</dd>
<dd><code>isHingeRight</code> - True if the hinge is on the right hand side, false if the hinge is on the left hand side.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../TreeSpecies.html" title="enum class in org.bukkit"><code>TreeSpecies</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.bukkit.Material,byte)">
<h3>Door</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="element-name">Door</span><wbr><span class="parameters">(<a href="../Material.html" title="enum class in org.bukkit">Material</a>&nbsp;type,
byte&nbsp;data)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Magic value</div>
</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>type</code> - the type</dd>
<dd><code>data</code> - the raw data value</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getWoodDoorOfSpecies(org.bukkit.TreeSpecies)">
<h3>getWoodDoorOfSpecies</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="../Material.html" title="enum class in org.bukkit">Material</a></span>&nbsp;<span class="element-name">getWoodDoorOfSpecies</span><wbr><span class="parameters">(<a href="../TreeSpecies.html" title="enum class in org.bukkit">TreeSpecies</a>&nbsp;species)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns the item type of a wooden door for the given tree species.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>species</code> - The species of wood door required.</dd>
<dt>Returns:</dt>
<dd>The item type for the given species.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../Material.html#LEGACY_WOODEN_DOOR"><code>Material.LEGACY_WOODEN_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_SPRUCE_DOOR"><code>Material.LEGACY_SPRUCE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_BIRCH_DOOR"><code>Material.LEGACY_BIRCH_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_JUNGLE_DOOR"><code>Material.LEGACY_JUNGLE_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_ACACIA_DOOR"><code>Material.LEGACY_ACACIA_DOOR</code></a></li>
<li><a href="../Material.html#LEGACY_DARK_OAK_DOOR"><code>Material.LEGACY_DARK_OAK_DOOR</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isOpen()">
<h3>isOpen</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isOpen</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Result is undefined if <code>isTopHalf()</code> is true.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Openable.html#isOpen()">isOpen</a></code>&nbsp;in interface&nbsp;<code><a href="Openable.html" title="interface in org.bukkit.material">Openable</a></code></dd>
<dt>Returns:</dt>
<dd>true if the door has swung counterclockwise around its hinge.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setOpen(boolean)">
<h3>setOpen</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setOpen</span><wbr><span class="parameters">(boolean&nbsp;isOpen)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Set whether the door is open. Undefined if <code>isTopHalf()</code> is true.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Openable.html#setOpen(boolean)">setOpen</a></code>&nbsp;in interface&nbsp;<code><a href="Openable.html" title="interface in org.bukkit.material">Openable</a></code></dd>
<dt>Parameters:</dt>
<dd><code>isOpen</code> - True to open the door.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isTopHalf()">
<h3>isTopHalf</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isTopHalf</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>whether this is the top half of the door</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setTopHalf(boolean)">
<h3>setTopHalf</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setTopHalf</span><wbr><span class="parameters">(boolean&nbsp;isTopHalf)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Configure this part of the door to be either the top or the bottom half</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>isTopHalf</code> - True to make it the top half.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHingeCorner()">
<h3>getHingeCorner</h3>
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
</span><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a></span>&nbsp;<span class="element-name">getHingeCorner</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">This method should not be used; use hinge and facing accessors instead.</div>
</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>BlockFace.SELF</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="MaterialData.html#toString()">toString</a></code>&nbsp;in class&nbsp;<code><a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setFacingDirection(org.bukkit.block.BlockFace)">
<h3>setFacingDirection</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setFacingDirection</span><wbr><span class="parameters">(<a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a>&nbsp;face)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Set the direction that this door should is facing.
Undefined if <code>isTopHalf()</code> is true.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Directional.html#setFacingDirection(org.bukkit.block.BlockFace)">setFacingDirection</a></code>&nbsp;in interface&nbsp;<code><a href="Directional.html" title="interface in org.bukkit.material">Directional</a></code></dd>
<dt>Parameters:</dt>
<dd><code>face</code> - the direction</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getFacing()">
<h3>getFacing</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../block/BlockFace.html" title="enum class in org.bukkit.block">BlockFace</a></span>&nbsp;<span class="element-name">getFacing</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Get the direction that this door is facing.
Undefined if <code>isTopHalf()</code> is true.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="Directional.html#getFacing()">getFacing</a></code>&nbsp;in interface&nbsp;<code><a href="Directional.html" title="interface in org.bukkit.material">Directional</a></code></dd>
<dt>Returns:</dt>
<dd>the direction</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getHinge()">
<h3>getHinge</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">getHinge</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Returns the side of the door the hinge is on.
Undefined if <code>isTopHalf()</code> is false.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>false for left hinge, true for right hinge</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setHinge(boolean)">
<h3>setHinge</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setHinge</span><wbr><span class="parameters">(boolean&nbsp;isHingeRight)</span></div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<div class="block">Set whether the hinge is on the left or right side. Left is false, right is true.
Undefined if <code>isTopHalf()</code> is false.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>isHingeRight</code> - True if the hinge is on the right hand side, false if the hinge is on the left hand side.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Door.html" title="class in org.bukkit.material">Door</a></span>&nbsp;<span class="element-name">clone</span>()</div>
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="MaterialData.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="MaterialData.html" title="class in org.bukkit.material">MaterialData</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>