funkemunky/commands
1
0
Fork 0
mirror of https://github.com/aikar/commands.git synced 2026-07-02 19:00:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update javadocs

Browse Source
This commit is contained in:
Aikar
2017-12-09 13:03:23 -05:00
parent d23588b046
commit e8a1a6bd52
5 changed files with 99 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/acf-bukkit/co/aikar/commands/BukkitCommandCompletionContext.html
+23 -4
View File
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10};
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<hr>
<br>
<pre>public class <a href="../../../src-html/co/aikar/commands/BukkitCommandCompletionContext.html#line.28">BukkitCommandCompletionContext</a>
<pre>public class <a href="../../../src-html/co/aikar/commands/BukkitCommandCompletionContext.html#line.29">BukkitCommandCompletionContext</a>
extends co.aikar.commands.CommandCompletionContext</pre>
</li>
</ul>
@@ -149,6 +149,12 @@ extends co.aikar.commands.CommandCompletionContext</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.bukkit.entity.Player</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../co/aikar/commands/BukkitCommandCompletionContext.html#getPlayer--">getPlayer</a></span>()</code>
<div class="block">Returns the Player object if this Issuer is a Player</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.bukkit.command.CommandSender</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../co/aikar/commands/BukkitCommandCompletionContext.html#getSender--">getSender</a></span>()</code>&nbsp;</td>
</tr>
@@ -184,10 +190,23 @@ extends co.aikar.commands.CommandCompletionContext</pre>
<a name="getSender--">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>getSender</h4>
<pre>public&nbsp;org.bukkit.command.CommandSender&nbsp;<a href="../../../src-html/co/aikar/commands/BukkitCommandCompletionContext.html#line.33">getSender</a>()</pre>
<pre>public&nbsp;org.bukkit.command.CommandSender&nbsp;<a href="../../../src-html/co/aikar/commands/BukkitCommandCompletionContext.html#line.34">getSender</a>()</pre>
</li>
</ul>
<a name="getPlayer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPlayer</h4>
<pre>public&nbsp;org.bukkit.entity.Player&nbsp;<a href="../../../src-html/co/aikar/commands/BukkitCommandCompletionContext.html#line.42">getPlayer</a>()</pre>
<div class="block">Returns the Player object if this Issuer is a Player</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
</li>
docs/acf-bukkit/co/aikar/commands/BukkitCommandExecutionContext.html
+23 -4
View File
@@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10};
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -113,7 +113,7 @@ var activeTableTab = "activeTableTab";
<li class="blockList">
<hr>
<br>
<pre>public class <a href="../../../src-html/co/aikar/commands/BukkitCommandExecutionContext.html#line.32">BukkitCommandExecutionContext</a>
<pre>public class <a href="../../../src-html/co/aikar/commands/BukkitCommandExecutionContext.html#line.33">BukkitCommandExecutionContext</a>
extends co.aikar.commands.CommandExecutionContext&lt;<a href="../../../co/aikar/commands/BukkitCommandExecutionContext.html" title="class in co.aikar.commands">BukkitCommandExecutionContext</a>,<a href="../../../co/aikar/commands/BukkitCommandIssuer.html" title="class in co.aikar.commands">BukkitCommandIssuer</a>&gt;</pre>
</li>
</ul>
@@ -149,6 +149,12 @@ extends co.aikar.commands.CommandExecutionContext&lt;<a href="../../../co/aikar/
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.bukkit.entity.Player</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../co/aikar/commands/BukkitCommandExecutionContext.html#getPlayer--">getPlayer</a></span>()</code>
<div class="block">Returns the Player object if this Issuer is a Player</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.bukkit.command.CommandSender</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../co/aikar/commands/BukkitCommandExecutionContext.html#getSender--">getSender</a></span>()</code>&nbsp;</td>
</tr>
@@ -184,10 +190,23 @@ extends co.aikar.commands.CommandExecutionContext&lt;<a href="../../../co/aikar/
<a name="getSender--">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>getSender</h4>
<pre>public&nbsp;org.bukkit.command.CommandSender&nbsp;<a href="../../../src-html/co/aikar/commands/BukkitCommandExecutionContext.html#line.38">getSender</a>()</pre>
<pre>public&nbsp;org.bukkit.command.CommandSender&nbsp;<a href="../../../src-html/co/aikar/commands/BukkitCommandExecutionContext.html#line.39">getSender</a>()</pre>
</li>
</ul>
<a name="getPlayer--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPlayer</h4>
<pre>public&nbsp;org.bukkit.entity.Player&nbsp;<a href="../../../src-html/co/aikar/commands/BukkitCommandExecutionContext.html#line.47">getPlayer</a>()</pre>
<div class="block">Returns the Player object if this Issuer is a Player</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
</li>
docs/acf-bukkit/index-all.html
+8
View File
@@ -217,6 +217,14 @@
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="co/aikar/commands/MinecraftMessageKeys.html#getMessageKey--">getMessageKey()</a></span> - Method in enum co.aikar.commands.<a href="co/aikar/commands/MinecraftMessageKeys.html" title="enum in co.aikar.commands">MinecraftMessageKeys</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="co/aikar/commands/BukkitCommandCompletionContext.html#getPlayer--">getPlayer()</a></span> - Method in class co.aikar.commands.<a href="co/aikar/commands/BukkitCommandCompletionContext.html" title="class in co.aikar.commands">BukkitCommandCompletionContext</a></dt>
<dd>
<div class="block">Returns the Player object if this Issuer is a Player</div>
</dd>
<dt><span class="memberNameLink"><a href="co/aikar/commands/BukkitCommandExecutionContext.html#getPlayer--">getPlayer()</a></span> - Method in class co.aikar.commands.<a href="co/aikar/commands/BukkitCommandExecutionContext.html" title="class in co.aikar.commands">BukkitCommandExecutionContext</a></dt>
<dd>
<div class="block">Returns the Player object if this Issuer is a Player</div>
</dd>
<dt><span class="memberNameLink"><a href="co/aikar/commands/contexts/OnlinePlayer.html#getPlayer--">getPlayer()</a></span> - Method in class co.aikar.commands.contexts.<a href="co/aikar/commands/contexts/OnlinePlayer.html" title="class in co.aikar.commands.contexts">OnlinePlayer</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="co/aikar/commands/BukkitCommandManager.html#getPlugin--">getPlugin()</a></span> - Method in class co.aikar.commands.<a href="co/aikar/commands/BukkitCommandManager.html" title="class in co.aikar.commands">BukkitCommandManager</a></dt>
docs/acf-bukkit/src-html/co/aikar/commands/BukkitCommandCompletionContext.html
+20 -10
View File
@@ -32,16 +32,26 @@
<span class="sourceLineNo">024</span>package co.aikar.commands;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.bukkit.command.CommandSender;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>public class BukkitCommandCompletionContext extends CommandCompletionContext {<a name="line.28"></a>
<span class="sourceLineNo">029</span> BukkitCommandCompletionContext(RegisteredCommand command, CommandIssuer issuer, String input, String config, String[] args) {<a name="line.29"></a>
<span class="sourceLineNo">030</span> super(command, issuer, input, config, args);<a name="line.30"></a>
<span class="sourceLineNo">031</span> }<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span> public CommandSender getSender() {<a name="line.33"></a>
<span class="sourceLineNo">034</span> return this.getIssuer().getIssuer();<a name="line.34"></a>
<span class="sourceLineNo">035</span> }<a name="line.35"></a>
<span class="sourceLineNo">036</span>}<a name="line.36"></a>
<span class="sourceLineNo">027</span>import org.bukkit.entity.Player;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>public class BukkitCommandCompletionContext extends CommandCompletionContext {<a name="line.29"></a>
<span class="sourceLineNo">030</span> BukkitCommandCompletionContext(RegisteredCommand command, CommandIssuer issuer, String input, String config, String[] args) {<a name="line.30"></a>
<span class="sourceLineNo">031</span> super(command, issuer, input, config, args);<a name="line.31"></a>
<span class="sourceLineNo">032</span> }<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> public CommandSender getSender() {<a name="line.34"></a>
<span class="sourceLineNo">035</span> return this.getIssuer().getIssuer();<a name="line.35"></a>
<span class="sourceLineNo">036</span> }<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Returns the Player object if this Issuer is a Player<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @return<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> public Player getPlayer() {<a name="line.42"></a>
<span class="sourceLineNo">043</span> CommandSender issuer = this.issuer.getIssuer();<a name="line.43"></a>
<span class="sourceLineNo">044</span> return issuer instanceof Player ? (Player) issuer : null;<a name="line.44"></a>
<span class="sourceLineNo">045</span> }<a name="line.45"></a>
<span class="sourceLineNo">046</span>}<a name="line.46"></a>
docs/acf-bukkit/src-html/co/aikar/commands/BukkitCommandExecutionContext.html
+25 -15
View File
@@ -32,21 +32,31 @@
<span class="sourceLineNo">024</span>package co.aikar.commands;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.bukkit.command.CommandSender;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.lang.reflect.Parameter;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.Map;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>public class BukkitCommandExecutionContext extends CommandExecutionContext&lt;BukkitCommandExecutionContext, BukkitCommandIssuer&gt; {<a name="line.32"></a>
<span class="sourceLineNo">033</span> BukkitCommandExecutionContext(RegisteredCommand cmd, Parameter param, BukkitCommandIssuer sender, List&lt;String&gt; args,<a name="line.33"></a>
<span class="sourceLineNo">034</span> int index, Map&lt;String, Object&gt; passedArgs) {<a name="line.34"></a>
<span class="sourceLineNo">035</span> super(cmd, param, sender, args, index, passedArgs);<a name="line.35"></a>
<span class="sourceLineNo">036</span> }<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> public CommandSender getSender() {<a name="line.38"></a>
<span class="sourceLineNo">039</span> return this.issuer.getIssuer();<a name="line.39"></a>
<span class="sourceLineNo">040</span> }<a name="line.40"></a>
<span class="sourceLineNo">041</span>}<a name="line.41"></a>
<span class="sourceLineNo">027</span>import org.bukkit.entity.Player;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.lang.reflect.Parameter;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.util.List;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.util.Map;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>public class BukkitCommandExecutionContext extends CommandExecutionContext&lt;BukkitCommandExecutionContext, BukkitCommandIssuer&gt; {<a name="line.33"></a>
<span class="sourceLineNo">034</span> BukkitCommandExecutionContext(RegisteredCommand cmd, Parameter param, BukkitCommandIssuer sender, List&lt;String&gt; args,<a name="line.34"></a>
<span class="sourceLineNo">035</span> int index, Map&lt;String, Object&gt; passedArgs) {<a name="line.35"></a>
<span class="sourceLineNo">036</span> super(cmd, param, sender, args, index, passedArgs);<a name="line.36"></a>
<span class="sourceLineNo">037</span> }<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> public CommandSender getSender() {<a name="line.39"></a>
<span class="sourceLineNo">040</span> return this.issuer.getIssuer();<a name="line.40"></a>
<span class="sourceLineNo">041</span> }<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * Returns the Player object if this Issuer is a Player<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @return<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public Player getPlayer() {<a name="line.47"></a>
<span class="sourceLineNo">048</span> CommandSender issuer = this.issuer.getIssuer();<a name="line.48"></a>
<span class="sourceLineNo">049</span> return issuer instanceof Player ? (Player) issuer : null;<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span>}<a name="line.51"></a>