Skip to content

Commit

Permalink
Publishing javadoc for SpongePowered/SpongeAPI 11.0.0-SNAPSHOT
Browse files Browse the repository at this point in the history
  • Loading branch information
spongie-jd[bot] committed May 18, 2024
1 parent edfe1ed commit a97a688
Show file tree
Hide file tree
Showing 11 changed files with 319 additions and 211 deletions.
7 changes: 2 additions & 5 deletions spongeapi/11.0.0-SNAPSHOT/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5886,11 +5886,8 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="block">Represents a type of <a href="org/spongepowered/api/world/server/Ticket.html" title="interface in org.spongepowered.api.world.server"><code>chunk loading ticket</code></a> that can be obtained
to ensure chunks remain loaded in a <a href="org/spongepowered/api/world/server/ServerWorld.html" title="interface in org.spongepowered.api.world.server"><code>ServerWorld</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="org/spongepowered/api/world/server/TicketTypes.html" title="class in org.spongepowered.api.world.server">TicketTypes</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Types of <a href="org/spongepowered/api/world/server/Ticket.html" title="interface in org.spongepowered.api.world.server"><code>tickets</code></a> that can be requested via the
<a href="org/spongepowered/api/world/server/ChunkManager.html" title="interface in org.spongepowered.api.world.server"><code>ChunkManager</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="org/spongepowered/api/world/server/TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder&lt;T&gt;</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="org/spongepowered/api/util/Ticks.html" title="interface in org.spongepowered.api.util">Ticks</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">Represents a game "tick".</div>
Expand Down
70 changes: 25 additions & 45 deletions spongeapi/11.0.0-SNAPSHOT/index-all.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion spongeapi/11.0.0-SNAPSHOT/member-search-index.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>TicketType.Builder (SpongeAPI 11.0.0-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.spongepowered.api.world.server, interface: TicketType, interface: Builder">
<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">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<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>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</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.spongepowered.api.world.server</a></div>
<h1 title="Interface TicketType.Builder" class="title">Interface TicketType.Builder&lt;T&gt;</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="../../util/ResettableBuilder.html" title="interface in org.spongepowered.api.util">ResettableBuilder</a>&lt;T,<wbr><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a>&lt;T&gt;&gt;</code></dd>
</dl>
<dl class="notes">
<dt>Enclosing interface:</dt>
<dd><code><a href="TicketType.html" title="interface in org.spongepowered.api.world.server">TicketType</a>&lt;<a href="TicketType.html" title="type parameter in TicketType">T</a>&gt;</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">TicketType.Builder&lt;T&gt;</span><span class="extends-implements">
extends <a href="../../util/ResettableBuilder.html" title="interface in org.spongepowered.api.util">ResettableBuilder</a>&lt;T,<wbr><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a>&lt;T&gt;&gt;</span></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== 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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<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 method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TicketType.html" title="interface in org.spongepowered.api.world.server">TicketType</a><wbr>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Builds a new <a href="TicketType.html" title="interface in org.spongepowered.api.world.server"><code>type</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a><wbr>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#comparator(java.util.Comparator)" class="member-name-link">comparator</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;&nbsp;comparator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link"><code>comparator</code></a> used by requested <a href="Ticket.html" title="interface in org.spongepowered.api.world.server"><code>tickets</code></a>
of this type used to determine the appropriate ticket to be used during collisions.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a><wbr>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#lifetime(org.spongepowered.api.util.Ticks)" class="member-name-link">lifetime</a><wbr>(<a href="../../util/Ticks.html" title="interface in org.spongepowered.api.util">Ticks</a>&nbsp;lifetime)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the lifetime of the <a href="TicketType.html" title="interface in org.spongepowered.api.world.server"><code>type</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a><wbr>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#name(java.lang.String)" class="member-name-link">name</a><wbr>(@NonNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Sets the name of the <a href="TicketType.html" title="interface in org.spongepowered.api.world.server"><code>type</code></a>.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.spongepowered.api.util.ResettableBuilder">Methods inherited from interface&nbsp;org.spongepowered.api.util.<a href="../../util/ResettableBuilder.html" title="interface in org.spongepowered.api.util">ResettableBuilder</a></h3>
<code><a href="../../util/ResettableBuilder.html#reset()">reset</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="name(java.lang.String)">
<h3>name</h3>
<div class="member-signature"><span class="return-type"><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</span>&nbsp;<span class="element-name">name</span><wbr><span class="parameters">(@NonNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Sets the name of the <a href="TicketType.html" title="interface in org.spongepowered.api.world.server"><code>type</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - The name</dd>
<dt>Returns:</dt>
<dd>The builder, for chaining</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="comparator(java.util.Comparator)">
<h3>comparator</h3>
<div class="member-signature"><span class="return-type"><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</span>&nbsp;<span class="element-name">comparator</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;&nbsp;comparator)</span></div>
<div class="block">Sets the <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link"><code>comparator</code></a> used by requested <a href="Ticket.html" title="interface in org.spongepowered.api.world.server"><code>tickets</code></a>
of this type used to determine the appropriate ticket to be used during collisions.
<p>
If this call is omitted, it is up to the implementation on how the comparison is handled.
In the official implementation, the resulting comparison value is '0'.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>comparator</code> - The comparator</dd>
<dt>Returns:</dt>
<dd>The builder, for chaining</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="lifetime(org.spongepowered.api.util.Ticks)">
<h3>lifetime</h3>
<div class="member-signature"><span class="return-type"><a href="TicketType.Builder.html" title="interface in org.spongepowered.api.world.server">TicketType.Builder</a>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</span>&nbsp;<span class="element-name">lifetime</span><wbr><span class="parameters">(<a href="../../util/Ticks.html" title="interface in org.spongepowered.api.util">Ticks</a>&nbsp;lifetime)</span></div>
<div class="block">Sets the lifetime of the <a href="TicketType.html" title="interface in org.spongepowered.api.world.server"><code>type</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>lifetime</code> - The lifetime</dd>
<dt>Returns:</dt>
<dd>The builder, for chaining</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="build()">
<h3>build</h3>
<div class="member-signature"><span class="return-type"><a href="TicketType.html" title="interface in org.spongepowered.api.world.server">TicketType</a>&lt;<a href="TicketType.Builder.html" title="type parameter in TicketType.Builder">T</a>&gt;</span>&nbsp;<span class="element-name">build</span>()</div>
<div class="block">Builds a new <a href="TicketType.html" title="interface in org.spongepowered.api.world.server"><code>type</code></a>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The type</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Loading

0 comments on commit a97a688

Please sign in to comment.