Package com.plotsquared.core.command

Class Help

java.lang.Object

com.plotsquared.core.command.Command

com.plotsquared.core.command.Help

public class Help
extends Command

Nested Class Summary

Nested classes/interfaces inherited from class com.plotsquared.core.command.Command

Command.CommandException, Command.CommandResult

Constructor Summary

Constructors

Constructor	Description
Help(Command parent)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(PlotPlayer<?> player, boolean message)
CompletableFuture<Boolean>	displayHelp(PlotPlayer<?> player, String catRaw, int page)
CompletableFuture<Boolean>	execute(PlotPlayer<?> player, String[] args, RunnableVal3<Command,Runnable,Runnable> confirm, RunnableVal2<Command,Command.CommandResult> whenDone)
Collection<Command>	tab(PlotPlayer<?> player, String[] args, boolean space)

Methods inherited from class com.plotsquared.core.command.Command

check, checkArgs, checkTrue, equals, getAliases, getCommand, getCommand, getCommandById, getCommands, getCommands, getCommands, getCommandString, getDescription, getFullId, getId, getMatch, getParent, getPermission, getRequiredArguments, getRequiredType, getUsage, hasConfirmation, hashCode, init, matches, paginate, register, sendUsage, setRequiredArguments, tabOf, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Help

public Help(Command parent)

Method Details

canExecute

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

Overrides:

canExecute in class Command

execute

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

Overrides:

execute in class Command

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

displayHelp

public CompletableFuture<Boolean> displayHelp(PlotPlayer<?> player,
 String catRaw,
 int page)

tab

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

Overrides:

tab in class Command