Scissors-Website/javadoc/1.19.4/org/bukkit/structure/class-use/Structure.html
2023-04-02 20:49:18 -05:00

177 lines
20 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Interface org.bukkit.structure.Structure (Scissors-API 1.19.4-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="use: package: org.bukkit.structure, interface: Structure">
<meta name="generator" content="javadoc/ClassUseWriter">
<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.6.0.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-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><a href="../Structure.html" title="interface in org.bukkit.structure">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<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">
<div class="header">
<h1 title="Uses of Interface org.bukkit.structure.Structure" class="title">Uses of Interface<br>org.bukkit.structure.Structure</h1>
</div>
<div class="caption"><span>Packages that use <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.bukkit.structure">org.bukkit.structure</a></div>
<div class="col-last even-row-color">
<div class="block">Classes related to creating or using <a href="../Structure.html" title="interface in org.bukkit.structure"><code>structures</code></a> without creating <a href="../../block/Structure.html" title="interface in org.bukkit.block"><code>Structure
blocks</code></a> in the world.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.bukkit.structure">
<h2>Uses of <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a> in <a href="../package-summary.html">org.bukkit.structure</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.structure</a> that return <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#copy(org.bukkit.structure.Structure)" class="member-name-link">copy</a><wbr>(<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a copy of this structure.</div>
</div>
<div class="col-first odd-row-color"><code><a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#createStructure()" class="member-name-link">createStructure</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a new empty structure.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#getStructure(org.bukkit.NamespacedKey)" class="member-name-link">getStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey)</code></div>
<div class="col-last even-row-color">
<div class="block">Gets a registered Structure.</div>
</div>
<div class="col-first odd-row-color"><code><a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#loadStructure(java.io.File)" class="member-name-link">loadStructure</a><wbr>(<a href="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> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;file)</code></div>
<div class="col-last odd-row-color">
<div class="block">Reads a Structure from disk.</div>
</div>
<div class="col-first even-row-color"><code><a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#loadStructure(java.io.InputStream)" class="member-name-link">loadStructure</a><wbr>(<a href="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> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;inputStream)</code></div>
<div class="col-last even-row-color">
<div class="block">Reads a Structure from a stream.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#loadStructure(org.bukkit.NamespacedKey)" class="member-name-link">loadStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey)</code></div>
<div class="col-last odd-row-color">
<div class="block">Loads the structure for the specified key and automatically registers it.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#loadStructure(org.bukkit.NamespacedKey,boolean)" class="member-name-link">loadStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey,
boolean&nbsp;register)</code></div>
<div class="col-last even-row-color">
<div class="block">Loads a structure for the specified key and optionally <a href="../StructureManager.html#registerStructure(org.bukkit.NamespacedKey,org.bukkit.structure.Structure)"><code>registers</code></a> it.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#registerStructure(org.bukkit.NamespacedKey,org.bukkit.structure.Structure)" class="member-name-link">registerStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey,
<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last odd-row-color">
<div class="block">Registers the given structure.</div>
</div>
<div class="col-first even-row-color"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#unregisterStructure(org.bukkit.NamespacedKey)" class="member-name-link">unregisterStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey)</code></div>
<div class="col-last even-row-color">
<div class="block">Unregisters a structure.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.structure</a> that return types with arguments of type <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="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> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>,<wbr><a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#getStructures()" class="member-name-link">getStructures</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Gets the currently registered structures.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.bukkit.structure</a> with parameters of type <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></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">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#copy(org.bukkit.structure.Structure)" class="member-name-link">copy</a><wbr>(<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a copy of this structure.</div>
</div>
<div class="col-first odd-row-color"><code><a href="https://javadoc.io/doc/org.jetbrains/annotations/23.0.0/org/jetbrains/annotations/Nullable.html" title="class or interface in org.jetbrains.annotations" class="external-link">@Nullable</a> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#registerStructure(org.bukkit.NamespacedKey,org.bukkit.structure.Structure)" class="member-name-link">registerStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey,
<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last odd-row-color">
<div class="block">Registers the given structure.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#saveStructure(java.io.File,org.bukkit.structure.Structure)" class="member-name-link">saveStructure</a><wbr>(<a href="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> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;file,
<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last even-row-color">
<div class="block">Save a structure to a file.</div>
</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#saveStructure(java.io.OutputStream,org.bukkit.structure.Structure)" class="member-name-link">saveStructure</a><wbr>(<a href="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> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;outputStream,
<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last odd-row-color">
<div class="block">Save a structure to a stream.</div>
</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">StructureManager.</span><code><a href="../StructureManager.html#saveStructure(org.bukkit.NamespacedKey,org.bukkit.structure.Structure)" class="member-name-link">saveStructure</a><wbr>(<a href="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> <a href="../../NamespacedKey.html" title="class in org.bukkit">NamespacedKey</a>&nbsp;structureKey,
<a href="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> <a href="../Structure.html" title="interface in org.bukkit.structure">Structure</a>&nbsp;structure)</code></div>
<div class="col-last even-row-color">
<div class="block">Saves a structure with a given key to the primary world folder.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
</div>
</div>
</body>
</html>