Plexus/Website
1
0
Fork 0
mirror of https://github.com/plexusorg/Website.git synced 2024-12-23 10:27:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
24bd8e2017
Website/static/javadoc/dev/plex/command/impl/CommandSpyCMD.html

242 lines
19 KiB
HTML
Raw Normal View History

Add javadocs
2024-11-30 20:17:10 +00:00
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) -->
<title>CommandSpyCMD (server 1.5-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: dev.plex.command.impl, class: CommandSpyCMD">
<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><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>Field</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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&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><a href="#constructor-detail">Constr</a>&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">dev.plex.command.impl</a></div>
<h1 title="Class CommandSpyCMD" class="title">Class CommandSpyCMD</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">org.bukkit.command.Command
<div class="inheritance"><a href="../PlexCommand.html" title="class in dev.plex.command">dev.plex.command.PlexCommand</a>
<div class="inheritance">dev.plex.command.impl.CommandSpyCMD</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>org.bukkit.command.PluginIdentifiableCommand</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CommandSpyCMD</span>
<span class="extends-implements">extends <a href="../PlexCommand.html" title="class in dev.plex.command">PlexCommand</a></span></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="inherited-list">
<h3 id="fields-inherited-from-class-dev.plex.command.PlexCommand">Fields inherited from class&nbsp;dev.plex.command.<a href="../PlexCommand.html" title="class in dev.plex.command">PlexCommand</a></h3>
<code><a href="../PlexCommand.html#plugin">plugin</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.bukkit.command.Command">Fields inherited from class&nbsp;org.bukkit.command.Command</h3>
<code>description, timings, usageMessage</code></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">CommandSpyCMD</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</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>protected net.kyori.adventure.text.Component</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(org.bukkit.command.CommandSender,org.bukkit.entity.Player,java.lang.String%5B%5D)" class="member-name-link">execute</a><wbr>(@NotNull org.bukkit.command.CommandSender&nbsp;sender,
@Nullable org.bukkit.entity.Player&nbsp;playerSender,
@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>[]&nbsp;args)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Executes the command</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/List.html" title="class or interface in java.util" class="external-link">List</a><wbr>&lt;<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>&gt;</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#smartTabComplete(org.bukkit.command.CommandSender,java.lang.String,java.lang.String%5B%5D)" class="member-name-link">smartTabComplete</a><wbr>(@NotNull org.bukkit.command.CommandSender&nbsp;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>&nbsp;alias,
@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>[]&nbsp;args)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-dev.plex.command.PlexCommand">Methods inherited from class&nbsp;dev.plex.command.<a href="../PlexCommand.html" title="class in dev.plex.command">PlexCommand</a></h3>
<code><a href="../PlexCommand.html#checkPermission(org.bukkit.command.CommandSender,java.lang.String)">checkPermission</a>, <a href="../PlexCommand.html#checkPermission(org.bukkit.entity.Player,java.lang.String)">checkPermission</a>, <a href="../PlexCommand.html#componentFromString(java.lang.String)">componentFromString</a>, <a href="../PlexCommand.html#getMap()">getMap</a>, <a href="../PlexCommand.html#getNonNullPlayer(java.lang.String)">getNonNullPlayer</a>, <a href="../PlexCommand.html#getNonNullWorld(java.lang.String)">getNonNullWorld</a>, <a href="../PlexCommand.html#getOfflinePlexPlayer(java.util.UUID)">getOfflinePlexPlayer</a>, <a href="../PlexCommand.html#getOnlinePlexPlayer(java.lang.String)">getOnlinePlexPlayer</a>, <a href="../PlexCommand.html#getPlexPlayer(org.bukkit.entity.Player)">getPlexPlayer</a>, <a href="../PlexCommand.html#getPlugin()">getPlugin</a>, <a href="../PlexCommand.html#getUUID(org.bukkit.command.CommandSender)">getUUID</a>, <a href="../PlexCommand.html#isConsole(org.bukkit.command.CommandSender)">isConsole</a>, <a href="../PlexCommand.html#messageComponent(java.lang.String,java.lang.Object...)">messageComponent</a>, <a href="../PlexCommand.html#messageComponent(java.lang.String,net.kyori.adventure.text.Component...)">messageComponent</a>, <a href="../PlexCommand.html#messageString(java.lang.String,java.lang.Object...)">messageString</a>, <a href="../PlexCommand.html#mmString(java.lang.String)">mmString</a>, <a href="../PlexCommand.html#noColorComponentFromString(java.lang.String)">noColorComponentFromString</a>, <a href="../PlexCommand.html#send(net.kyori.adventure.audience.Audience,java.lang.String)">send</a>, <a href="../PlexCommand.html#send(net.kyori.adventure.audience.Audience,net.kyori.adventure.text.Component)">send</a>, <a href="../PlexCommand.html#silentCheckPermission(org.bukkit.command.CommandSender,java.lang.String)">silentCheckPermission</a>, <a href="../PlexCommand.html#silentCheckPermission(org.bukkit.entity.Player,java.lang.String)">silentCheckPermission</a>, <a href="../PlexCommand.html#tabComplete(org.bukkit.command.CommandSender,java.lang.String,java.lang.String%5B%5D)">tabComplete</a>, <a href="../PlexCommand.html#usage()">usage</a>, <a href="../PlexCommand.html#usage(java.lang.String)">usage</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.command.Command">Methods inherited from class&nbsp;org.bukkit.command.Command</h3>
<code>broadcastCommandMessage, broadcastCommandMessage, broadcastCommandMessage, broadcastCommandMessage, canBeOverriden, getAliases, getDescription, getLabel, getName, getPermission, getPermissionMessage, getTimingName, getUsage, isRegistered, permissionMessage, permissionMessage, register, setAliases, setDescription, setLabel, setName, setPermission, setPermissionMessage, setUsage, tabComplete, testPermission, testPermissionSilent, toString, unregister</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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#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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>CommandSpyCMD</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">CommandSpyCMD</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="execute(org.bukkit.command.CommandSender,org.bukkit.entity.Player,java.lang.String[])">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">net.kyori.adventure.text.Component</span>&nbsp;<span class="element-name">execute</span><wbr><span class="parameters">(@NotNull
@NotNull org.bukkit.command.CommandSender&nbsp;sender,
@Nullable
@Nullable org.bukkit.entity.Player&nbsp;playerSender,
@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>[]&nbsp;args)</span></div>
<div class="block"><span class="description-from-type-label">Description copied from class:&nbsp;<code><a href="../PlexCommand.html#execute(org.bukkit.command.CommandSender,org.bukkit.entity.Player,java.lang.String%5B%5D)">PlexCommand</a></code></span></div>
<div class="block">Executes the command</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../PlexCommand.html#execute(org.bukkit.command.CommandSender,org.bukkit.entity.Player,java.lang.String%5B%5D)">execute</a></code>&nbsp;in class&nbsp;<code><a href="../PlexCommand.html" title="class in dev.plex.command">PlexCommand</a></code></dd>
<dt>Parameters:</dt>
<dd><code>sender</code> - The sender of the command</dd>
<dd><code>playerSender</code> - The player who executed the command (null if CommandSource is console or if CommandSource is any but console executed)</dd>
<dd><code>args</code> - A Kyori Component to send to the sender (can be null)</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="smartTabComplete(org.bukkit.command.CommandSender,java.lang.String,java.lang.String[])">
<h3>smartTabComplete</h3>
<div class="member-signature"><span class="annotations">@NotNull
</span><span class="modifiers">public</span>&nbsp;<span class="return-type">@NotNull <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<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>&gt;</span>&nbsp;<span class="element-name">smartTabComplete</span><wbr><span class="parameters">(@NotNull
@NotNull org.bukkit.command.CommandSender&nbsp;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>&nbsp;alias,
@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>[]&nbsp;args)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../PlexCommand.html#smartTabComplete(org.bukkit.command.CommandSender,java.lang.String,java.lang.String%5B%5D)">smartTabComplete</a></code>&nbsp;in class&nbsp;<code><a href="../PlexCommand.html" title="class in dev.plex.command">PlexCommand</a></code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink