|
|
|
@ -2,7 +2,7 @@
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<!-- Generated by javadoc (17) -->
|
|
|
|
|
<title>PlexModule (server 1.1 API)</title>
|
|
|
|
|
<title>PlexModule (server 1.1.1 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: dev.plex.module, class: PlexModule">
|
|
|
|
@ -135,6 +135,19 @@ loadScripts(document, 'script');</script>
|
|
|
|
|
<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-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDefaultMessage(java.lang.String,java.lang.Object)" class="member-name-link">addDefaultMessage</a><wbr>(<a href="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> message,
|
|
|
|
|
<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> initValue)</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Adds a message to the messages.yml file</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDefaultMessage(java.lang.String,java.lang.Object,java.lang.String...)" class="member-name-link">addDefaultMessage</a><wbr>(<a href="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> message,
|
|
|
|
|
<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> initValue,
|
|
|
|
|
<a href="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>... comments)</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Adds a message to the messages.yml with a comment</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disable()" class="member-name-link">disable</a>()</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
@ -151,16 +164,24 @@ loadScripts(document, 'script');</script>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerCommand(dev.plex.command.PlexCommand)" class="member-name-link">registerCommand</a><wbr>(<a href="../command/PlexCommand.html" title="class in dev.plex.command">PlexCommand</a> command)</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Registers a PlexCommand within a module</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerListener(dev.plex.listener.PlexListener)" class="member-name-link">registerListener</a><wbr>(<a href="../listener/PlexListener.html" title="class in dev.plex.listener">PlexListener</a> listener)</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Registers a PlexListener within a module</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unregisterCommand(dev.plex.command.PlexCommand)" class="member-name-link">unregisterCommand</a><wbr>(<a href="../command/PlexCommand.html" title="class in dev.plex.command">PlexCommand</a> command)</code></div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Unregisters a PlexCommand.</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
|
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unregisterListener(dev.plex.listener.PlexListener)" class="member-name-link">unregisterListener</a><wbr>(<a href="../listener/PlexListener.html" title="class in dev.plex.listener">PlexListener</a> listener)</code></div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
|
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
|
|
|
<div class="block">Unregisters a PlexListener.</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
@ -258,24 +279,44 @@ loadScripts(document, 'script');</script>
|
|
|
|
|
<section class="detail" id="registerListener(dev.plex.listener.PlexListener)">
|
|
|
|
|
<h3>registerListener</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerListener</span><wbr><span class="parameters">(<a href="../listener/PlexListener.html" title="class in dev.plex.listener">PlexListener</a> listener)</span></div>
|
|
|
|
|
<div class="block">Registers a PlexListener within a module</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>listener</code> - The PlexListener to be registered</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="unregisterListener(dev.plex.listener.PlexListener)">
|
|
|
|
|
<h3>unregisterListener</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unregisterListener</span><wbr><span class="parameters">(<a href="../listener/PlexListener.html" title="class in dev.plex.listener">PlexListener</a> listener)</span></div>
|
|
|
|
|
<div class="block">Unregisters a PlexListener. Handled by Plex automatically</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>listener</code> - The PlexListener to be registered</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="registerCommand(dev.plex.command.PlexCommand)">
|
|
|
|
|
<h3>registerCommand</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">registerCommand</span><wbr><span class="parameters">(<a href="../command/PlexCommand.html" title="class in dev.plex.command">PlexCommand</a> command)</span></div>
|
|
|
|
|
<div class="block">Registers a PlexCommand within a module</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>command</code> - The PlexCommand to be registered</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="unregisterCommand(dev.plex.command.PlexCommand)">
|
|
|
|
|
<h3>unregisterCommand</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unregisterCommand</span><wbr><span class="parameters">(<a href="../command/PlexCommand.html" title="class in dev.plex.command">PlexCommand</a> command)</span></div>
|
|
|
|
|
<div class="block">Unregisters a PlexCommand. Handled by Plex automatically</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>command</code> - The PlexCommand to be registered</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
@ -285,6 +326,34 @@ loadScripts(document, 'script');</script>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="addDefaultMessage(java.lang.String,java.lang.Object)">
|
|
|
|
|
<h3>addDefaultMessage</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addDefaultMessage</span><wbr><span class="parameters">(<a href="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> message,
|
|
|
|
|
<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> initValue)</span></div>
|
|
|
|
|
<div class="block">Adds a message to the messages.yml file</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>message</code> - The key value for the message</dd>
|
|
|
|
|
<dd><code>initValue</code> - The message itself</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="addDefaultMessage(java.lang.String,java.lang.Object,java.lang.String...)">
|
|
|
|
|
<h3>addDefaultMessage</h3>
|
|
|
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addDefaultMessage</span><wbr><span class="parameters">(<a href="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> message,
|
|
|
|
|
<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> initValue,
|
|
|
|
|
<a href="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>... comments)</span></div>
|
|
|
|
|
<div class="block">Adds a message to the messages.yml with a comment</div>
|
|
|
|
|
<dl class="notes">
|
|
|
|
|
<dt>Parameters:</dt>
|
|
|
|
|
<dd><code>message</code> - The key value for the message</dd>
|
|
|
|
|
<dd><code>initValue</code> - The message itself</dd>
|
|
|
|
|
<dd><code>comments</code> - The comments to be placed above the message</dd>
|
|
|
|
|
</dl>
|
|
|
|
|
</section>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<section class="detail" id="getResource(java.lang.String)">
|
|
|
|
|
<h3>getResource</h3>
|
|
|
|
|
<div class="member-signature"><span class="annotations">@Nullable
|
|
|
|
|