Scissors-Website/public/javadoc/1.19/org/bukkit/generator/structure/StructureType.html
2022-07-05 18:33:56 -05:00

306 lines
20 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>StructureType (Scissors-API 1.19-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.generator.structure, class: StructureType">
<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 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><a href="#field-summary">Field</a>&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><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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.generator.structure</a></div>
<h1 title="Class StructureType" class="title">Class StructureType</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">org.bukkit.generator.structure.StructureType</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>net.kyori.adventure.key.Keyed</code>, <code><a href="../../Keyed.html" title="interface in org.bukkit">Keyed</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">StructureType</span>
<span class="extends-implements">extends <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>
implements <a href="../../Keyed.html" title="interface in org.bukkit">Keyed</a></span></div>
<div class="block">Represent a StructureType of a <a href="Structure.html" title="class in org.bukkit.generator.structure"><code>Structure</code></a>.
Listed structure types are present in the default server. Depending on the
server there might be additional structure types present (for example
structure types added by data packs), which can be received via
<a href="../../Registry.html#STRUCTURE_TYPE"><code>Registry.STRUCTURE_TYPE</code></a>.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#BURIED_TREASURE" class="member-name-link">BURIED_TREASURE</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#DESERT_PYRAMID" class="member-name-link">DESERT_PYRAMID</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#END_CITY" class="member-name-link">END_CITY</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#FORTRESS" class="member-name-link">FORTRESS</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#IGLOO" class="member-name-link">IGLOO</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#JIGSAW" class="member-name-link">JIGSAW</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#JUNGLE_TEMPLE" class="member-name-link">JUNGLE_TEMPLE</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#MINESHAFT" class="member-name-link">MINESHAFT</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#NETHER_FOSSIL" class="member-name-link">NETHER_FOSSIL</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#OCEAN_MONUMENT" class="member-name-link">OCEAN_MONUMENT</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#OCEAN_RUIN" class="member-name-link">OCEAN_RUIN</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#RUINED_PORTAL" class="member-name-link">RUINED_PORTAL</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#SHIPWRECK" class="member-name-link">SHIPWRECK</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#STRONGHOLD" class="member-name-link">STRONGHOLD</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second even-row-color"><code><a href="#SWAMP_HUT" class="member-name-link">SWAMP_HUT</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></code></div>
<div class="col-second odd-row-color"><code><a href="#WOODLAND_MANSION" class="member-name-link">WOODLAND_MANSION</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== 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">StructureType</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<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#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <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#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</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#toString()" title="class or interface in java.lang" class="external-link">toString</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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.Keyed">Methods inherited from interface&nbsp;org.bukkit.<a href="../../Keyed.html" title="interface in org.bukkit">Keyed</a></h3>
<code><a href="../../Keyed.html#getKey()">getKey</a>, <a href="../../Keyed.html#key()">key</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="BURIED_TREASURE">
<h3>BURIED_TREASURE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">BURIED_TREASURE</span></div>
</section>
</li>
<li>
<section class="detail" id="DESERT_PYRAMID">
<h3>DESERT_PYRAMID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">DESERT_PYRAMID</span></div>
</section>
</li>
<li>
<section class="detail" id="END_CITY">
<h3>END_CITY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">END_CITY</span></div>
</section>
</li>
<li>
<section class="detail" id="FORTRESS">
<h3>FORTRESS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">FORTRESS</span></div>
</section>
</li>
<li>
<section class="detail" id="IGLOO">
<h3>IGLOO</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">IGLOO</span></div>
</section>
</li>
<li>
<section class="detail" id="JIGSAW">
<h3>JIGSAW</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">JIGSAW</span></div>
</section>
</li>
<li>
<section class="detail" id="JUNGLE_TEMPLE">
<h3>JUNGLE_TEMPLE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">JUNGLE_TEMPLE</span></div>
</section>
</li>
<li>
<section class="detail" id="MINESHAFT">
<h3>MINESHAFT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">MINESHAFT</span></div>
</section>
</li>
<li>
<section class="detail" id="NETHER_FOSSIL">
<h3>NETHER_FOSSIL</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">NETHER_FOSSIL</span></div>
</section>
</li>
<li>
<section class="detail" id="OCEAN_MONUMENT">
<h3>OCEAN_MONUMENT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">OCEAN_MONUMENT</span></div>
</section>
</li>
<li>
<section class="detail" id="OCEAN_RUIN">
<h3>OCEAN_RUIN</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">OCEAN_RUIN</span></div>
</section>
</li>
<li>
<section class="detail" id="RUINED_PORTAL">
<h3>RUINED_PORTAL</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">RUINED_PORTAL</span></div>
</section>
</li>
<li>
<section class="detail" id="SHIPWRECK">
<h3>SHIPWRECK</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">SHIPWRECK</span></div>
</section>
</li>
<li>
<section class="detail" id="STRONGHOLD">
<h3>STRONGHOLD</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">STRONGHOLD</span></div>
</section>
</li>
<li>
<section class="detail" id="SWAMP_HUT">
<h3>SWAMP_HUT</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">SWAMP_HUT</span></div>
</section>
</li>
<li>
<section class="detail" id="WOODLAND_MANSION">
<h3>WOODLAND_MANSION</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="StructureType.html" title="class in org.bukkit.generator.structure">StructureType</a></span>&nbsp;<span class="element-name">WOODLAND_MANSION</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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>StructureType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">StructureType</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>