<h1title="Enum Class BlockFace"class="title">Enum Class BlockFace</h1>
</div>
<divclass="inheritance"title="Inheritance Tree"><ahref="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>
<divclass="inheritance"><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html"title="class or interface in java.lang"class="external-link">java.lang.Enum</a><<ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a>>
<dd><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html"title="class or interface in java.io"class="external-link">Serializable</a></code>, <code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html"title="class or interface in java.lang"class="external-link">Comparable</a><<ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a>></code>, <code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html"title="class or interface in java.lang.constant"class="external-link">Constable</a></code></dd>
<spanclass="extends-implements">extends <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html"title="class or interface in java.lang"class="external-link">Enum</a><<ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a>></span></div>
<divclass="block">Represents the face of a block</div>
<h2id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html"title="class or interface in java.lang"class="external-link">Enum</a></h2>
<code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html"title="class or interface in java.lang"class="external-link">Enum.EnumDesc</a><<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html"title="class or interface in java.lang"class="external-link">E</a> extends <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html"title="class or interface in java.lang"class="external-link">Enum</a><<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html"title="class or interface in java.lang"class="external-link">E</a>>></code></div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="../util/Vector.html"title="class in org.bukkit.util">Vector</a></code></div>
<divclass="block">Get the amount of Z-coordinates to modify to get the represented block</div>
</div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></code></div>
<divclass="block">Returns true if this face is aligned with one of the unit axes in 3D
Cartesian space (ie NORTH, SOUTH, EAST, WEST, UP, DOWN).</div>
</div>
<divclass="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></code></div>
<divclass="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><ahref="#valueOf(java.lang.String)"class="member-name-link">valueOf</a><wbr>(<ahref="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> name)</code></div>
<divclass="block">Returns the enum constant of this class with the specified name.</div>
</div>
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a>[]</code></div>
<divclass="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</div>
</div>
</div>
</div>
<divclass="inherited-list">
<h3id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html"title="class or interface in java.lang"class="external-link">Enum</a></h3>
<code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()"title="class or interface in java.lang"class="external-link">clone</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)"title="class or interface in java.lang"class="external-link">compareTo</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()"title="class or interface in java.lang"class="external-link">describeConstable</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)"title="class or interface in java.lang"class="external-link">equals</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()"title="class or interface in java.lang"class="external-link">finalize</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()"title="class or interface in java.lang"class="external-link">getDeclaringClass</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()"title="class or interface in java.lang"class="external-link">hashCode</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()"title="class or interface in java.lang"class="external-link">name</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()"title="class or interface in java.lang"class="external-link">ordinal</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()"title="class or interface in java.lang"class="external-link">toString</a>, <ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)"title="class or interface in java.lang"class="external-link">valueOf</a></code></div>
<divclass="inherited-list">
<h3id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<ahref="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><ahref="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>, <ahref="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>, <ahref="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>, <ahref="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>, <ahref="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>, <ahref="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>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">NORTH</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="EAST">
<h3>EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="SOUTH">
<h3>SOUTH</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">SOUTH</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="WEST">
<h3>WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="UP">
<h3>UP</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">UP</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="DOWN">
<h3>DOWN</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">DOWN</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="NORTH_EAST">
<h3>NORTH_EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">NORTH_EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="NORTH_WEST">
<h3>NORTH_WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">NORTH_WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="SOUTH_EAST">
<h3>SOUTH_EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">SOUTH_EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="SOUTH_WEST">
<h3>SOUTH_WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">SOUTH_WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="WEST_NORTH_WEST">
<h3>WEST_NORTH_WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">WEST_NORTH_WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="NORTH_NORTH_WEST">
<h3>NORTH_NORTH_WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">NORTH_NORTH_WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="NORTH_NORTH_EAST">
<h3>NORTH_NORTH_EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">NORTH_NORTH_EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="EAST_NORTH_EAST">
<h3>EAST_NORTH_EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">EAST_NORTH_EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="EAST_SOUTH_EAST">
<h3>EAST_SOUTH_EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">EAST_SOUTH_EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="SOUTH_SOUTH_EAST">
<h3>SOUTH_SOUTH_EAST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">SOUTH_SOUTH_EAST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="SOUTH_SOUTH_WEST">
<h3>SOUTH_SOUTH_WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">SOUTH_SOUTH_WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="WEST_SOUTH_WEST">
<h3>WEST_SOUTH_WEST</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">WEST_SOUTH_WEST</span></div>
</section>
</li>
<li>
<sectionclass="detail"id="SELF">
<h3>SELF</h3>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">SELF</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<sectionclass="method-details"id="method-detail">
<h2>Method Details</h2>
<ulclass="member-list">
<li>
<sectionclass="detail"id="values()">
<h3>values</h3>
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a>[]</span> <spanclass="element-name">values</span>()</div>
<divclass="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
<divclass="member-signature"><spanclass="modifiers">public static</span> <spanclass="return-type"><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">valueOf</span><wbr><spanclass="parameters">(<ahref="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> name)</span></div>
<divclass="block">Returns the enum constant of this class with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this class. (Extraneous whitespace characters are
not permitted.)</div>
<dlclass="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt>Returns:</dt>
<dd>the enum constant with the specified name</dd>
<dt>Throws:</dt>
<dd><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html"title="class or interface in java.lang"class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd>
<dd><code><ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html"title="class or interface in java.lang"class="external-link">NullPointerException</a></code> - if the argument is null</dd>
<divclass="block">Get the amount of Z-coordinates to modify to get the represented block</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Amount of Z-coordinates to modify</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getDirection()">
<h3>getDirection</h3>
<divclass="member-signature"><spanclass="annotations"><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
</span><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="../util/Vector.html"title="class in org.bukkit.util">Vector</a></span> <spanclass="element-name">getDirection</span>()</div>
<divclass="block">Gets the normal vector corresponding to this block face.</div>
<divclass="block">Returns true if this face is aligned with one of the unit axes in 3D
Cartesian space (ie NORTH, SOUTH, EAST, WEST, UP, DOWN).</div>
<dlclass="notes">
<dt>Returns:</dt>
<dd>Cartesian status</dd>
</dl>
</section>
</li>
<li>
<sectionclass="detail"id="getOppositeFace()">
<h3>getOppositeFace</h3>
<divclass="member-signature"><spanclass="annotations"><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a>
</span><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/NotNull.html"title="class or interface in org.jetbrains.annotations"class="external-link">@NotNull</a><ahref="BlockFace.html"title="enum class in org.bukkit.block">BlockFace</a></span> <spanclass="element-name">getOppositeFace</span>()</div>
