mirror of
https://github.com/Minestom/Minestom.git
synced 2024-11-07 19:31:37 +01:00
335 lines
15 KiB
HTML
335 lines
15 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>CommandProcessor (Minestom 1.0 API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="description" content="declaration: package: net.minestom.server.command, interface: CommandProcessor">
|
|
<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.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":18,"i1":6,"i2":6,"i3":6,"i4":18,"i5":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flexBox">
|
|
<header role="banner" class="flexHeader">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a id="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">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">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navListSearch"><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="skipNav"><a id="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
</nav>
|
|
</header>
|
|
<div class="flexContent">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">net.minestom.server.command</a></div>
|
|
<h1 title="Interface CommandProcessor" class="title">Interface CommandProcessor</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<section class="description">
|
|
<hr>
|
|
<pre>public interface <span class="typeNameLabel">CommandProcessor</span></pre>
|
|
<div class="block">Represents a simple command which give you the whole string representation
|
|
<p>
|
|
<a href="#process(net.minestom.server.command.CommandSender,java.lang.String,java.lang.String%5B%5D)"><code>process(CommandSender, String, String[])</code></a> is called no matter what if a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a> sends a command which
|
|
start by <a href="#getCommandName()"><code>getCommandName()</code></a> or any of the aliases in <a href="#getAliases()"><code>getAliases()</code></a>
|
|
<p>
|
|
Tab-completion can be activated by overriding <a href="#enableWritingTracking()"><code>enableWritingTracking()</code></a> and return true, you should then listen to
|
|
<a href="#onWrite(java.lang.String)"><code>onWrite(String)</code></a> and return the possible completions to suggest.
|
|
<p>
|
|
Please be sure to check <a href="builder/Command.html" title="class in net.minestom.server.command.builder"><code>Command</code></a> as it is likely to be better for your use case.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t5" class="tableTab" onclick="show(16);">Default Methods</button></div>
|
|
<div id="memberSummary_tabpanel" role="tabpanel">
|
|
<table aria-labelledby="t0">
|
|
<thead>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="altColor" id="i0">
|
|
<td class="colFirst"><code>default boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableWritingTracking()">enableWritingTracking</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Needed to enable <a href="#onWrite(java.lang.String)"><code>onWrite(String)</code></a> callback.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code>java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAliases()">getAliases</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the command's aliases.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCommandName()">getCommandName</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the main command's name.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasAccess(net.minestom.server.entity.Player)">hasAccess</a></span>​(<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Called to know if a player has access to the command.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor" id="i4">
|
|
<td class="colFirst"><code>default java.lang.String[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onWrite(java.lang.String)">onWrite</a></span>​(java.lang.String text)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allows for tab auto completion, this is called everytime the player press a key in the chat.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i5">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#process(net.minestom.server.command.CommandSender,java.lang.String,java.lang.String%5B%5D)">process</a></span>​(<a href="CommandSender.html" title="interface in net.minestom.server.command">CommandSender</a> sender,
|
|
java.lang.String command,
|
|
java.lang.String[] args)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Called when the command is executed by a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li class="blockList">
|
|
<section class="methodDetails"><a id="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Details</h2>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getCommandName()">getCommandName</a></h3>
|
|
<div class="memberSignature"><span class="annotations">@NotNull
|
|
</span><span class="returnType">java.lang.String</span> <span class="memberName">getCommandName</span>()</div>
|
|
<div class="block">Gets the main command's name.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the main command's name</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getAliases()">getAliases</a></h3>
|
|
<div class="memberSignature"><span class="annotations">@Nullable
|
|
</span><span class="returnType">java.lang.String[]</span> <span class="memberName">getAliases</span>()</div>
|
|
<div class="block">Gets the command's aliases.
|
|
<p>
|
|
Can be null or empty.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the command aliases</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="process(net.minestom.server.command.CommandSender,java.lang.String,java.lang.String[])">process</a></h3>
|
|
<div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">process</span>​(<span class="arguments">@NotNull
|
|
<a href="CommandSender.html" title="interface in net.minestom.server.command">CommandSender</a> sender,
|
|
@NotNull
|
|
java.lang.String command,
|
|
@NotNull
|
|
java.lang.String[] args)</span></div>
|
|
<div class="block">Called when the command is executed by a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sender</code> - the sender which executed the command</dd>
|
|
<dd><code>command</code> - the command name used</dd>
|
|
<dd><code>args</code> - an array containing all the args (split by space char)</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true when the command is successful, false otherwise</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="hasAccess(net.minestom.server.entity.Player)">hasAccess</a></h3>
|
|
<div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">hasAccess</span>​(<span class="arguments">@NotNull
|
|
<a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</span></div>
|
|
<div class="block">Called to know if a player has access to the command.
|
|
<p>
|
|
Right now it is only used to know if the player should see the command in auto-completion
|
|
Conditions still need to be checked in <a href="#process(net.minestom.server.command.CommandSender,java.lang.String,java.lang.String%5B%5D)"><code>process(CommandSender, String, String[])</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>player</code> - the player to check the access</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true if the player has access to the command, false otherwise</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="enableWritingTracking()">enableWritingTracking</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">boolean</span> <span class="memberName">enableWritingTracking</span>()</div>
|
|
<div class="block">Needed to enable <a href="#onWrite(java.lang.String)"><code>onWrite(String)</code></a> callback.
|
|
<p>
|
|
Be aware that enabling it can cost some performance because of how often it will be called.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>true to enable writing tracking (and server auto completion)</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#onWrite(java.lang.String)"><code>onWrite(String)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="onWrite(java.lang.String)">onWrite</a></h3>
|
|
<div class="memberSignature"><span class="annotations">@Nullable
|
|
</span><span class="modifiers">default</span> <span class="returnType">java.lang.String[]</span> <span class="memberName">onWrite</span>​(<span class="arguments">@NotNull
|
|
java.lang.String text)</span></div>
|
|
<div class="block">Allows for tab auto completion, this is called everytime the player press a key in the chat.
|
|
<p>
|
|
WARNING: <a href="#enableWritingTracking()"><code>enableWritingTracking()</code></a> needs to return true, you need to override it by default.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>text</code> - the whole player text</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the array containing all the suggestion for the current arg (split " "), can be null</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#enableWritingTracking()"><code>enableWritingTracking()</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<nav role="navigation">
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a id="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a id="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">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">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|