Skip to content

Commit

Permalink
Publishing javadoc for SpongePowered/SpongeAPI 13.0.0-SNAPSHOT
Browse files Browse the repository at this point in the history
  • Loading branch information
spongie-jd[bot] committed Oct 25, 2024
1 parent eeec952 commit ebf616a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
3 changes: 2 additions & 1 deletion spongeapi/13.0.0-SNAPSHOT/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -51385,7 +51385,8 @@ <h2 class="title" id="I:W">W</h2>
</dd>
<dt><a href="org/spongepowered/api/world/server/WorldManager.html#worldDirectory(org.spongepowered.api.ResourceKey)" class="member-name-link">worldDirectory(ResourceKey)</a> - Method in interface org.spongepowered.api.world.server.<a href="org/spongepowered/api/world/server/WorldManager.html" title="interface in org.spongepowered.api.world.server">WorldManager</a></dt>
<dd>
<div class="block">Gets a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>directory</code></a> that exists for the provided <a href="org/spongepowered/api/ResourceKey.html" title="interface in org.spongepowered.api"><code>world key</code></a>.</div>
<div class="block">Gets a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>directory</code></a> that is used for the world's data
identified by <a href="org/spongepowered/api/ResourceKey.html" title="interface in org.spongepowered.api"><code>world key</code></a>.</div>
</dd>
<dt><a href="org/spongepowered/api/world/server/WorldManager.html#worldExists(org.spongepowered.api.ResourceKey)" class="member-name-link">worldExists(ResourceKey)</a> - Method in interface org.spongepowered.api.world.server.<a href="org/spongepowered/api/world/server/WorldManager.html" title="interface in org.spongepowered.api.world.server">WorldManager</a></dt>
<dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,11 @@ <h2>Method Summary</h2>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a <a href="ServerWorld.html" title="interface in org.spongepowered.api.world.server"><code>world</code></a> by a <a href="../../ResourceKey.html" title="interface in org.spongepowered.api"><code>key</code></a>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>&gt;</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#worldDirectory(org.spongepowered.api.ResourceKey)" class="member-name-link">worldDirectory</a><wbr>(<a href="../../ResourceKey.html" title="interface in org.spongepowered.api">ResourceKey</a>&nbsp;key)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Gets a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>directory</code></a> that exists for the provided <a href="../../ResourceKey.html" title="interface in org.spongepowered.api"><code>world key</code></a>.</div>
<div class="block">Gets a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>directory</code></a> that is used for the world's data
identified by <a href="../../ResourceKey.html" title="interface in org.spongepowered.api"><code>world key</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#worldExists(org.spongepowered.api.ResourceKey)" class="member-name-link">worldExists</a><wbr>(<a href="../../ResourceKey.html" title="interface in org.spongepowered.api">ResourceKey</a>&nbsp;key)</code></div>
Expand Down Expand Up @@ -235,16 +236,15 @@ <h3>world</h3>
<li>
<section class="detail" id="worldDirectory(org.spongepowered.api.ResourceKey)">
<h3>worldDirectory</h3>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a>&gt;</span>&nbsp;<span class="element-name">worldDirectory</span><wbr><span class="parameters">(<a href="../../ResourceKey.html" title="interface in org.spongepowered.api">ResourceKey</a>&nbsp;key)</span></div>
<div class="block">Gets a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>directory</code></a> that exists for the provided <a href="../../ResourceKey.html" title="interface in org.spongepowered.api"><code>world key</code></a>.

<p>It is not required for the implementation to validate that the directory contains a proper world,
only that the directory exists.</p></div>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link">Path</a></span>&nbsp;<span class="element-name">worldDirectory</span><wbr><span class="parameters">(<a href="../../ResourceKey.html" title="interface in org.spongepowered.api">ResourceKey</a>&nbsp;key)</span></div>
<div class="block">Gets a <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Path.html" title="class or interface in java.nio.file" class="external-link"><code>directory</code></a> that is used for the world's data
identified by <a href="../../ResourceKey.html" title="interface in org.spongepowered.api"><code>world key</code></a>. It is not guaranteed
the path will exist until the world is formally loaded by the game.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>key</code> - The key</dd>
<dd><code>key</code> - The world's identifier key</dd>
<dt>Returns:</dt>
<dd>The directory or <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Optional.html#empty()" title="class or interface in java.util" class="external-link"><code>Optional.empty()</code></a> if not found</dd>
<dd>The directory to be used if it doesn't exist</dd>
</dl>
</section>
</li>
Expand Down

0 comments on commit ebf616a

Please sign in to comment.