Plan/all/com/djrapitops/plan/commands/use/SpongeCommand.html

374 lines
16 KiB
HTML
Raw Normal View History

2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="fi">
<head>
2020-03-21 15:43:05 +01:00
<!-- Generated by javadoc -->
2020-10-11 17:01:29 +02:00
<title>SpongeCommand (Plan 5.1-SNAPSHOT API)</title>
2019-08-05 11:13:19 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
2020-10-11 17:01:29 +02:00
parent.document.title="SpongeCommand (Plan 5.1-SNAPSHOT API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
2020-01-24 11:56:15 +01:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
2019-08-05 11:13:19 +02:00
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<ul class="navList">
2020-10-11 17:01:29 +02:00
<li><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCMDSender.html" title="class in com.djrapitops.plan.commands.use"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/djrapitops/plan/commands/use/SpongeMessageBuilder.html" title="class in com.djrapitops.plan.commands.use"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2020-10-11 17:01:29 +02:00
<li><a href="../../../../../index.html?com/djrapitops/plan/commands/use/SpongeCommand.html" target="_top">Frames</a></li>
<li><a href="SpongeCommand.html" target="_top">No&nbsp;Frames</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
2020-10-11 17:01:29 +02:00
<div class="subTitle">com.djrapitops.plan.commands.use</div>
<h2 title="Class SpongeCommand" class="title">Class SpongeCommand</h2>
2019-08-05 11:13:19 +02:00
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
2020-10-11 17:01:29 +02:00
<li>com.djrapitops.plan.commands.use.SpongeCommand</li>
2019-08-05 11:13:19 +02:00
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
2020-10-11 17:01:29 +02:00
<dd>org.spongepowered.api.command.CommandCallable</dd>
2019-08-05 11:13:19 +02:00
</dl>
<hr>
<br>
2020-10-11 17:01:29 +02:00
<pre>public class <span class="typeNameLabel">SpongeCommand</span>
2019-08-05 11:13:19 +02:00
extends java.lang.Object
2020-10-11 17:01:29 +02:00
implements org.spongepowered.api.command.CommandCallable</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
2020-10-11 17:01:29 +02:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#SpongeCommand-com.djrapitops.plugin.task.RunnableFactory-com.djrapitops.plan.utilities.logging.ErrorLogger-com.djrapitops.plan.commands.use.Subcommand-">SpongeCommand</a></span>(com.djrapitops.plugin.task.RunnableFactory&nbsp;runnableFactory,
<a href="../../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title="class in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger,
<a href="../../../../../com/djrapitops/plan/commands/use/Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;command)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
2020-10-11 17:01:29 +02:00
<td class="colFirst"><code>java.util.Optional&lt;org.spongepowered.api.text.Text&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#getHelp-org.spongepowered.api.command.CommandSource-">getHelp</a></span>(org.spongepowered.api.command.CommandSource&nbsp;source)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i1" class="rowColor">
2020-10-11 17:01:29 +02:00
<td class="colFirst"><code>java.util.Optional&lt;org.spongepowered.api.text.Text&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#getShortDescription-org.spongepowered.api.command.CommandSource-">getShortDescription</a></span>(org.spongepowered.api.command.CommandSource&nbsp;source)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i2" class="altColor">
2020-10-11 17:01:29 +02:00
<td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#getSuggestions-org.spongepowered.api.command.CommandSource-java.lang.String-org.spongepowered.api.world.Location-">getSuggestions</a></span>(org.spongepowered.api.command.CommandSource&nbsp;source,
java.lang.String&nbsp;arguments,
org.spongepowered.api.world.Location&lt;org.spongepowered.api.world.World&gt;&nbsp;targetPosition)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
<tr id="i3" class="rowColor">
2020-10-11 17:01:29 +02:00
<td class="colFirst"><code>org.spongepowered.api.text.Text</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#getUsage-org.spongepowered.api.command.CommandSource-">getUsage</a></span>(org.spongepowered.api.command.CommandSource&nbsp;source)</code>&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i4" class="altColor">
2020-10-11 17:01:29 +02:00
<td class="colFirst"><code>org.spongepowered.api.command.CommandResult</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#process-org.spongepowered.api.command.CommandSource-java.lang.String-">process</a></span>(org.spongepowered.api.command.CommandSource&nbsp;source,
java.lang.String&nbsp;arguments)</code>&nbsp;</td>
2020-01-24 11:56:15 +01:00
</tr>
<tr id="i5" class="rowColor">
2020-10-11 17:01:29 +02:00
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCommand.html#testPermission-org.spongepowered.api.command.CommandSource-">testPermission</a></span>(org.spongepowered.api.command.CommandSource&nbsp;source)</code>&nbsp;</td>
2019-08-05 11:13:19 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
2020-10-11 17:01:29 +02:00
<a name="SpongeCommand-com.djrapitops.plugin.task.RunnableFactory-com.djrapitops.plan.utilities.logging.ErrorLogger-com.djrapitops.plan.commands.use.Subcommand-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>SpongeCommand</h4>
<pre>public&nbsp;SpongeCommand(com.djrapitops.plugin.task.RunnableFactory&nbsp;runnableFactory,
<a href="../../../../../com/djrapitops/plan/utilities/logging/ErrorLogger.html" title="class in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger,
<a href="../../../../../com/djrapitops/plan/commands/use/Subcommand.html" title="class in com.djrapitops.plan.commands.use">Subcommand</a>&nbsp;command)</pre>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
2020-10-11 17:01:29 +02:00
<a name="process-org.spongepowered.api.command.CommandSource-java.lang.String-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>process</h4>
<pre>public&nbsp;org.spongepowered.api.command.CommandResult&nbsp;process(org.spongepowered.api.command.CommandSource&nbsp;source,
java.lang.String&nbsp;arguments)</pre>
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
2020-10-11 17:01:29 +02:00
<dd><code>process</code>&nbsp;in interface&nbsp;<code>org.spongepowered.api.command.CommandCallable</code></dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
2020-10-11 17:01:29 +02:00
<a name="getSuggestions-org.spongepowered.api.command.CommandSource-java.lang.String-org.spongepowered.api.world.Location-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>getSuggestions</h4>
<pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getSuggestions(org.spongepowered.api.command.CommandSource&nbsp;source,
java.lang.String&nbsp;arguments,
@Nullable
org.spongepowered.api.world.Location&lt;org.spongepowered.api.world.World&gt;&nbsp;targetPosition)</pre>
2019-08-05 11:13:19 +02:00
<dl>
2020-01-24 11:56:15 +01:00
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
2020-10-11 17:01:29 +02:00
<dd><code>getSuggestions</code>&nbsp;in interface&nbsp;<code>org.spongepowered.api.command.CommandCallable</code></dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
2020-10-11 17:01:29 +02:00
<a name="testPermission-org.spongepowered.api.command.CommandSource-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>testPermission</h4>
<pre>public&nbsp;boolean&nbsp;testPermission(org.spongepowered.api.command.CommandSource&nbsp;source)</pre>
2019-08-05 11:13:19 +02:00
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
2020-10-11 17:01:29 +02:00
<dd><code>testPermission</code>&nbsp;in interface&nbsp;<code>org.spongepowered.api.command.CommandCallable</code></dd>
2019-08-05 11:13:19 +02:00
</dl>
</li>
</ul>
2020-10-11 17:01:29 +02:00
<a name="getShortDescription-org.spongepowered.api.command.CommandSource-">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>getShortDescription</h4>
<pre>public&nbsp;java.util.Optional&lt;org.spongepowered.api.text.Text&gt;&nbsp;getShortDescription(org.spongepowered.api.command.CommandSource&nbsp;source)</pre>
2020-01-24 11:56:15 +01:00
<dl>
2020-10-11 17:01:29 +02:00
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getShortDescription</code>&nbsp;in interface&nbsp;<code>org.spongepowered.api.command.CommandCallable</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
</li>
</ul>
2020-10-11 17:01:29 +02:00
<a name="getHelp-org.spongepowered.api.command.CommandSource-">
2020-01-24 11:56:15 +01:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>getHelp</h4>
<pre>public&nbsp;java.util.Optional&lt;org.spongepowered.api.text.Text&gt;&nbsp;getHelp(org.spongepowered.api.command.CommandSource&nbsp;source)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getHelp</code>&nbsp;in interface&nbsp;<code>org.spongepowered.api.command.CommandCallable</code></dd>
</dl>
2020-01-24 11:56:15 +01:00
</li>
</ul>
2020-10-11 17:01:29 +02:00
<a name="getUsage-org.spongepowered.api.command.CommandSource-">
2019-08-05 11:13:19 +02:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
2020-10-11 17:01:29 +02:00
<h4>getUsage</h4>
<pre>public&nbsp;org.spongepowered.api.text.Text&nbsp;getUsage(org.spongepowered.api.command.CommandSource&nbsp;source)</pre>
2020-01-24 11:56:15 +01:00
<dl>
2020-10-11 17:01:29 +02:00
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getUsage</code>&nbsp;in interface&nbsp;<code>org.spongepowered.api.command.CommandCallable</code></dd>
2020-01-24 11:56:15 +01:00
</dl>
2019-08-05 11:13:19 +02:00
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<ul class="navList">
2020-10-11 17:01:29 +02:00
<li><a href="../../../../../com/djrapitops/plan/commands/use/SpongeCMDSender.html" title="class in com.djrapitops.plan.commands.use"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/djrapitops/plan/commands/use/SpongeMessageBuilder.html" title="class in com.djrapitops.plan.commands.use"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList">
2020-10-11 17:01:29 +02:00
<li><a href="../../../../../index.html?com/djrapitops/plan/commands/use/SpongeCommand.html" target="_top">Frames</a></li>
<li><a href="SpongeCommand.html" target="_top">No&nbsp;Frames</a></li>
2019-08-05 11:13:19 +02:00
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>