mirror of https://github.com/Minestom/Minestom.git
442 lines
33 KiB
HTML
442 lines
33 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) -->
|
|
<title>CommandManager (minestom dev 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: net.minestom.server.command, class: CommandManager">
|
|
<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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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><a href="#field-summary">Field</a></li>
|
|
<li><a href="#constructor-summary">Constr</a></li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p>Detail:</p>
|
|
<ul>
|
|
<li><a href="#field-detail">Field</a></li>
|
|
<li><a href="#constructor-detail">Constr</a></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: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field-summary">Field</a> | </li>
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li><a href="#field-detail">Field</a> | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">net.minestom.server.command</a></div>
|
|
<h1 title="Class CommandManager" class="title">Class CommandManager</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">net.minestom.server.command.CommandManager</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CommandManager</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Manager used to register <a href="builder/Command.html" title="class in net.minestom.server.command.builder"><code>commands</code></a>.
|
|
<p>
|
|
It is also possible to simulate a command using <a href="#execute(net.minestom.server.command.CommandSender,java.lang.String)"><code>execute(CommandSender, String)</code></a>.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li>
|
|
<section class="field-summary" id="field-summary">
|
|
<h2>Field Summary</h2>
|
|
<div class="caption"><span>Fields</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">Field</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static final <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></code></div>
|
|
<div class="col-second even-row-color"><code><a href="#COMMAND_PREFIX" class="member-name-link">COMMAND_PREFIX</a></code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CommandManager</a>()</code></div>
|
|
<div class="col-last even-row-color"> </div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#commandExists(java.lang.String)" class="member-name-link">commandExists</a><wbr>(@NotNull <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> commandName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets if a command with the name <code>commandName</code> already exists or not.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="../network/packet/server/play/DeclareCommandsPacket.html" title="class in net.minestom.server.network.packet.server.play">DeclareCommandsPacket</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createDeclareCommandsPacket(net.minestom.server.entity.Player)" class="member-name-link">createDeclareCommandsPacket</a><wbr>(@NotNull <a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets the <a href="../network/packet/server/play/DeclareCommandsPacket.html" title="class in net.minestom.server.network.packet.server.play"><code>DeclareCommandsPacket</code></a> for a specific player.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="builder/CommandResult.html" title="class in net.minestom.server.command.builder">CommandResult</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(net.minestom.server.command.CommandSender,java.lang.String)" class="member-name-link">execute</a><wbr>(@NotNull <a href="CommandSender.html" title="interface in net.minestom.server.command">CommandSender</a> sender,
|
|
@NotNull <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> command)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Executes a command for a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="builder/CommandResult.html" title="class in net.minestom.server.command.builder">CommandResult</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#executeServerCommand(java.lang.String)" class="member-name-link">executeServerCommand</a><wbr>(@NotNull <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> command)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Executes the command using a <a href="ServerSender.html" title="class in net.minestom.server.command"><code>ServerSender</code></a>.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCommand(java.lang.String)" class="member-name-link">getCommand</a><wbr>(@NotNull <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> commandName)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets the <a href="builder/Command.html" title="class in net.minestom.server.command.builder"><code>Command</code></a> registered by <a href="#register(net.minestom.server.command.builder.Command)"><code>register(Command)</code></a>.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><wbr><@NotNull <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCommands()" class="member-name-link">getCommands</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="ConsoleSender.html" title="class in net.minestom.server.command">ConsoleSender</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConsoleSender()" class="member-name-link">getConsoleSender</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets the <a href="ConsoleSender.html" title="class in net.minestom.server.command"><code>ConsoleSender</code></a> (which is used as a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a>).</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@NotNull <a href="builder/CommandDispatcher.html" title="class in net.minestom.server.command.builder">CommandDispatcher</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDispatcher()" class="member-name-link">getDispatcher</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../utils/callback/CommandCallback.html" title="interface in net.minestom.server.utils.callback">CommandCallback</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnknownCommandCallback()" class="member-name-link">getUnknownCommandCallback</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Gets the callback executed once an unknown command is run.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CommandParser.Result.html" title="interface in net.minestom.server.command">CommandParser.Result</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseCommand(net.minestom.server.command.CommandSender,java.lang.String)" class="member-name-link">parseCommand</a><wbr>(@NotNull <a href="CommandSender.html" title="interface in net.minestom.server.command">CommandSender</a> sender,
|
|
<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> input)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Parses the command based on the registered commands</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="#register(net.minestom.server.command.builder.Command)" class="member-name-link">register</a><wbr>(@NotNull <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a> command)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Registers a <a href="builder/Command.html" title="class in net.minestom.server.command.builder"><code>Command</code></a>.</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="#setUnknownCommandCallback(net.minestom.server.utils.callback.CommandCallback)" class="member-name-link">setUnknownCommandCallback</a><wbr>(@Nullable <a href="../utils/callback/CommandCallback.html" title="interface in net.minestom.server.utils.callback">CommandCallback</a> unknownCommandCallback)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the callback executed once an unknown command is run.</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="#unregister(net.minestom.server.command.builder.Command)" class="member-name-link">unregister</a><wbr>(@NotNull <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a> command)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Removes a command from the currently registered commands.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<li>
|
|
<section class="field-details" id="field-detail">
|
|
<h2>Field Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="COMMAND_PREFIX">
|
|
<h3>COMMAND_PREFIX</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><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></span> <span class="element-name">COMMAND_PREFIX</span></div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list">
|
|
<li><a href="../../../../constant-values.html#net.minestom.server.command.CommandManager.COMMAND_PREFIX">Constant Field Values</a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>CommandManager</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CommandManager</span>()</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="register(net.minestom.server.command.builder.Command)">
|
|
<h3>register</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">register</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a> command)</span></div>
|
|
<div class="block">Registers a <a href="builder/Command.html" title="class in net.minestom.server.command.builder"><code>Command</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>command</code> - the command to register</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if a command with the same name already exists</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="unregister(net.minestom.server.command.builder.Command)">
|
|
<h3>unregister</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">unregister</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a> command)</span></div>
|
|
<div class="block">Removes a command from the currently registered commands.
|
|
Does nothing if the command was not registered before</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>command</code> - the command to remove</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCommand(java.lang.String)">
|
|
<h3>getCommand</h3>
|
|
<div class="member-signature"><span class="annotations">@Nullable
|
|
</span><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a></span> <span class="element-name">getCommand</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <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> commandName)</span></div>
|
|
<div class="block">Gets the <a href="builder/Command.html" title="class in net.minestom.server.command.builder"><code>Command</code></a> registered by <a href="#register(net.minestom.server.command.builder.Command)"><code>register(Command)</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>commandName</code> - the command name</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the command associated with the name, null if not any</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="commandExists(java.lang.String)">
|
|
<h3>commandExists</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">commandExists</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <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> commandName)</span></div>
|
|
<div class="block">Gets if a command with the name <code>commandName</code> already exists or not.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>commandName</code> - the command name to check</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>true if the command does exist</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="execute(net.minestom.server.command.CommandSender,java.lang.String)">
|
|
<h3>execute</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="builder/CommandResult.html" title="class in net.minestom.server.command.builder">CommandResult</a></span> <span class="element-name">execute</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="CommandSender.html" title="interface in net.minestom.server.command">CommandSender</a> sender,
|
|
@NotNull
|
|
@NotNull <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> command)</span></div>
|
|
<div class="block">Executes a command for a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a>.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>sender</code> - the sender of the command</dd>
|
|
<dd><code>command</code> - the raw command string (without the command prefix)</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the execution result</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="executeServerCommand(java.lang.String)">
|
|
<h3>executeServerCommand</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="builder/CommandResult.html" title="class in net.minestom.server.command.builder">CommandResult</a></span> <span class="element-name">executeServerCommand</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <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> command)</span></div>
|
|
<div class="block">Executes the command using a <a href="ServerSender.html" title="class in net.minestom.server.command"><code>ServerSender</code></a>. This can be used
|
|
to run a silent command (nothing is printed to console).</div>
|
|
<dl class="notes">
|
|
<dt>See Also:</dt>
|
|
<dd>
|
|
<ul class="tag-list-long">
|
|
<li><a href="#execute(net.minestom.server.command.CommandSender,java.lang.String)"><code>execute(CommandSender, String)</code></a></li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDispatcher()">
|
|
<h3>getDispatcher</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="builder/CommandDispatcher.html" title="class in net.minestom.server.command.builder">CommandDispatcher</a></span> <span class="element-name">getDispatcher</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getUnknownCommandCallback()">
|
|
<h3>getUnknownCommandCallback</h3>
|
|
<div class="member-signature"><span class="annotations">@Nullable
|
|
</span><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="../utils/callback/CommandCallback.html" title="interface in net.minestom.server.utils.callback">CommandCallback</a></span> <span class="element-name">getUnknownCommandCallback</span>()</div>
|
|
<div class="block">Gets the callback executed once an unknown command is run.</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the unknown command callback, null if not any</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setUnknownCommandCallback(net.minestom.server.utils.callback.CommandCallback)">
|
|
<h3>setUnknownCommandCallback</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setUnknownCommandCallback</span><wbr><span class="parameters">(@Nullable
|
|
@Nullable <a href="../utils/callback/CommandCallback.html" title="interface in net.minestom.server.utils.callback">CommandCallback</a> unknownCommandCallback)</span></div>
|
|
<div class="block">Sets the callback executed once an unknown command is run.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>unknownCommandCallback</code> - the new unknown command callback,
|
|
setting it to null mean that nothing will be executed</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConsoleSender()">
|
|
<h3>getConsoleSender</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="ConsoleSender.html" title="class in net.minestom.server.command">ConsoleSender</a></span> <span class="element-name">getConsoleSender</span>()</div>
|
|
<div class="block">Gets the <a href="ConsoleSender.html" title="class in net.minestom.server.command"><code>ConsoleSender</code></a> (which is used as a <a href="CommandSender.html" title="interface in net.minestom.server.command"><code>CommandSender</code></a>).</div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>the <a href="ConsoleSender.html" title="class in net.minestom.server.command"><code>ConsoleSender</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="createDeclareCommandsPacket(net.minestom.server.entity.Player)">
|
|
<h3>createDeclareCommandsPacket</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="../network/packet/server/play/DeclareCommandsPacket.html" title="class in net.minestom.server.network.packet.server.play">DeclareCommandsPacket</a></span> <span class="element-name">createDeclareCommandsPacket</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="../entity/Player.html" title="class in net.minestom.server.entity">Player</a> player)</span></div>
|
|
<div class="block">Gets the <a href="../network/packet/server/play/DeclareCommandsPacket.html" title="class in net.minestom.server.network.packet.server.play"><code>DeclareCommandsPacket</code></a> for a specific player.
|
|
<p>
|
|
Can be used to update a player auto-completion list.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>player</code> - the player to get the commands packet</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the <a href="../network/packet/server/play/DeclareCommandsPacket.html" title="class in net.minestom.server.network.packet.server.play"><code>DeclareCommandsPacket</code></a> for <code>player</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCommands()">
|
|
<h3>getCommands</h3>
|
|
<div class="member-signature"><span class="annotations">@NotNull
|
|
</span><span class="modifiers">public</span> <span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><@NotNull <a href="builder/Command.html" title="class in net.minestom.server.command.builder">Command</a>></span> <span class="element-name">getCommands</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="parseCommand(net.minestom.server.command.CommandSender,java.lang.String)">
|
|
<h3>parseCommand</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CommandParser.Result.html" title="interface in net.minestom.server.command">CommandParser.Result</a></span> <span class="element-name">parseCommand</span><wbr><span class="parameters">(@NotNull
|
|
@NotNull <a href="CommandSender.html" title="interface in net.minestom.server.command">CommandSender</a> sender,
|
|
<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> input)</span></div>
|
|
<div class="block">Parses the command based on the registered commands</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>input</code> - commands string without prefix</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the parsing result</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|