Package dev.satyrn.xpeconomy.commands

Class HelpCommandHandler

java.lang.Object

dev.satyrn.papermc.api.commands.v1.CommandHandler

dev.satyrn.xpeconomy.api.commands.VaultCommandHandler

dev.satyrn.xpeconomy.commands.HelpCommandHandler

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter

public class HelpCommandHandler
extends VaultCommandHandler

Constructor Summary

Constructors

Constructor	Description
HelpCommandHandler(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull net.milkbowl.vault.permission.Permission permission)	Creates a handler for the help subcommand.

Method Summary

Modifier and Type	Method	Description
boolean	onCommand(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String label, @NotNull String[] args)	Executes the given command, returning its success.
@Nullable List<String>	onTabComplete(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String alias, @NotNull String[] args)	Requests a list of possible completions for a command argument.

Methods inherited from class dev.satyrn.xpeconomy.api.commands.VaultCommandHandler

getPermission

Methods inherited from class dev.satyrn.papermc.api.commands.v1.CommandHandler

getPlugin, getUsage, setupCommand, setupCommand, setUsage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HelpCommandHandler

public HelpCommandHandler(@NotNull
 @NotNull org.bukkit.plugin.Plugin plugin,
 @NotNull
 @NotNull net.milkbowl.vault.permission.Permission permission)

Creates a handler for the help subcommand.

Parameters:

plugin - The plugin instance.

permission - The permission instance.

Method Details

onCommand

public boolean onCommand(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull org.bukkit.command.Command command,
 @NotNull
 @NotNull String label,
 @NotNull
 @NotNull String[] args)

Executes the given command, returning its success.
If false is returned, then the "usage" plugin.yml entry for this command (if defined) will be sent to the player.

Parameters:

sender - Source of the command

command - Command which was executed

label - Alias of the command which was used

args - Passed command arguments

Returns:

true if a valid command, otherwise false

onTabComplete

@Nullable
public @Nullable List<String> onTabComplete(@NotNull
 @NotNull org.bukkit.command.CommandSender sender,
 @NotNull
 @NotNull org.bukkit.command.Command command,
 @NotNull
 @NotNull String alias,
 @NotNull
 @NotNull String[] args)

Requests a list of possible completions for a command argument.

Parameters:

sender - Source of the command. For players tab-completing a command inside a command block, this will be the player, not the command block.

command - Command which was executed

alias - The alias used

args - The arguments passed to the command, including final partial argument to be completed and command label

Returns:

A List of possible completions for the final argument, or null to default to the command executor