OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-02 17:32:03 +01:00
Code Issues Projects Releases Packages Wiki Activity

PluginCommand getExecutor + javadocs

Browse source 
By: Dinnerbone <dinnerbone@dinnerbone.com>
This commit is contained in:
Bukkit/Spigot 2011-02-28 10:35:58 +00:00
parent 9c2782bea7
commit 5256cbb8a8
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
paper-api/src/main/java/org/bukkit/command/PluginCommand.java
View file

@ -2,6 +2,9 @@ package org.bukkit.command;
import org.bukkit.plugin.Plugin;
/**
* Represents a {@link Command} belonging to a plugin
*/
public final class PluginCommand extends Command {
private final Plugin owningPlugin;
private CommandExecutor executor;
@ -13,6 +16,14 @@ public final class PluginCommand extends Command {
this.usageMessage = "";
}
/**
* Executes the command, returning its success
*
* @param sender Source object which is executing this command
* @param commandLabel The alias of the command used
* @param args All arguments passed to the command, split via ' '
* @return true if the command was successful, otherwise false
*/
public boolean execute(CommandSender sender, String commandLabel, String[] args) {
boolean success = false;
@ -29,10 +40,24 @@ public final class PluginCommand extends Command {
return success;
}
/**
* Sets the {@link CommandExecutor} to run when parsing this command
*
* @param executor New executor to run
*/
public void setExecutor(CommandExecutor executor) {
this.executor = executor;
}
/**
* Gets the {@link CommandExecutor} associated with this command
*
* @return CommandExecutor object linked to this command
*/
public CommandExecutor getExecutor() {
return executor;
}
/**
* Gets the owner of this PluginCommand
*