Package com.plotsquared.core.command

Class Command

java.lang.Object

com.plotsquared.core.command.Command

Direct Known Subclasses:

Add, Backup, Buy, Clear, DebugImportWorlds, FlagCommand, Grant, Help, HomeCommand, Leave, MainCommand, Near, SubCommand, Toggle, Trust, Visit

public abstract class Command
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Command.CommandException
static enum	Command.CommandResult

Constructor Summary

Constructors

Constructor	Description
Command(Command parent, boolean isStatic)
Command(Command parent, boolean isStatic, String id, String permission, RequiredType required, CommandCategory category)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(PlotPlayer<?> player, boolean message)
<T> T	check(T object, Caption message, net.kyori.adventure.text.minimessage.Template... args)
boolean	checkArgs(PlotPlayer<?> player, String[] args)
void	checkTrue(boolean mustBeTrue, Caption message, net.kyori.adventure.text.minimessage.Template... args)
boolean	equals(Object obj)
CompletableFuture<Boolean>	execute(PlotPlayer<?> player, String[] args, RunnableVal3<Command,Runnable,Runnable> confirm, RunnableVal2<Command,Command.CommandResult> whenDone)
List<String>	getAliases()
Command	getCommand(Class<?> clazz)
Command	getCommand(String arg)
Command	getCommandById(String id)
List<Command>	getCommands()
List<Command>	getCommands(CommandCategory category, PlotPlayer<?> player)
List<Command>	getCommands(PlotPlayer<?> player)
String	getCommandString()
Caption	getDescription()
String	getFullId()
String	getId()
int	getMatch(String[] args, Command cmd, PlotPlayer<?> player)
Command	getParent()
String	getPermission()
Argument<?>[]	getRequiredArguments()
RequiredType	getRequiredType()
String	getUsage()
boolean	hasConfirmation(PermissionHolder player)
int	hashCode()
void	init(CommandDeclaration declaration)
boolean	matches(String arg)
<T> void	paginate(PlotPlayer<?> player, List<T> c, int size, int page, RunnableVal3<Integer,T,CaptionHolder> add, String baseCommand, Caption header)
void	register(Command command)
void	sendUsage(PlotPlayer<?> player)
void	setRequiredArguments(Argument<?>[] arguments)
Collection<Command>	tab(PlotPlayer<?> player, String[] args, boolean space)
Collection<Command>	tabOf(PlotPlayer<?> player, String[] input, boolean space, String... args)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Command

public Command(Command parent,
 boolean isStatic,
 String id,
 String permission,
 RequiredType required,
 CommandCategory category)

Command

public Command(Command parent,
 boolean isStatic)

Method Details

getParent

public Command getParent()

getId

public String getId()

getFullId

public String getFullId()

getCommands

public List<Command> getCommands(PlotPlayer<?> player)

getCommands

public List<Command> getCommands(CommandCategory category,
 PlotPlayer<?> player)

getCommands

public List<Command> getCommands()

hasConfirmation

public boolean hasConfirmation(PermissionHolder player)

getAliases

public List<String> getAliases()

getDescription

public Caption getDescription()

getRequiredType

public RequiredType getRequiredType()

getRequiredArguments

public Argument<?>[] getRequiredArguments()

setRequiredArguments

public void setRequiredArguments(Argument<?>[] arguments)

init

public void init(CommandDeclaration declaration)

register

public void register(Command command)

getPermission

public String getPermission()

paginate

public <T> void paginate(PlotPlayer<?> player,
 List<T> c,
 int size,
 int page,
 RunnableVal3<Integer,T,CaptionHolder> add,
 String baseCommand,
 Caption header)

execute

public CompletableFuture<Boolean> execute(PlotPlayer<?> player,
 String[] args,
 RunnableVal3<Command,Runnable,Runnable> confirm,
 RunnableVal2<Command,Command.CommandResult> whenDone)
                                   throws Command.CommandException

Parameters:

player - Caller

args - Arguments

confirm - Instance, Success, Failure

whenDone - task to run when done

Returns:

CompletableFuture true if the command executed fully, false in any other case

Throws:

Command.CommandException

checkArgs

public boolean checkArgs(PlotPlayer<?> player,
 String[] args)

getMatch

public int getMatch(String[] args,
 Command cmd,
 PlotPlayer<?> player)

getCommand

public Command getCommand(String arg)

getCommand

public Command getCommand(Class<?> clazz)

getCommandById

public Command getCommandById(String id)

canExecute

public boolean canExecute(PlotPlayer<?> player,
 boolean message)

matches

public boolean matches(String arg)

getCommandString

public String getCommandString()

sendUsage

public void sendUsage(PlotPlayer<?> player)

getUsage

public String getUsage()

tabOf

public Collection<Command> tabOf(PlotPlayer<?> player,
 String[] input,
 boolean space,
 String... args)

tab

public Collection<Command> tab(PlotPlayer<?> player,
 String[] args,
 boolean space)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

checkTrue

public void checkTrue(boolean mustBeTrue,
 Caption message,
 net.kyori.adventure.text.minimessage.Template... args)

check

public <T> T check(T object,
 Caption message,
 net.kyori.adventure.text.minimessage.Template... args)