Package com.booksaw.betterTeams.commands

Class HelpCommand

java.lang.Object

com.booksaw.betterTeams.commands.SubCommand

com.booksaw.betterTeams.commands.HelpCommand

public class HelpCommand
extends SubCommand

Field Summary

Fields

Modifier and Type	Field	Description
static String	description
static String	prefix

Constructor Summary

Constructors

Constructor	Description
HelpCommand(ParentCommand command)

Method Summary

Modifier and Type	Method	Description
net.md_5.bungee.api.chat.TextComponent	createClickableHelpMessage(String label, String commandPath, String description)
net.kyori.adventure.text.Component	createClickableHelpMiniMessage(String label, String commandPath, String description)
String	createHelpMessage(String label, String commandPath, String description)	Used to create a formatted help message to explain what a command does to the user
void	fullyCustom(org.bukkit.command.CommandSender sender, String label)	Used to send a fully custom help message which is stored in a file
String	getArguments()
String	getCommand()
String	getHelp()
int	getMaximumArguments()	return -1 if there is no cap
int	getMinimumArguments()	Used to get the minimum number of arguments which need to be parsed into this command
String	getNode()
CommandResponse	onCommand(org.bukkit.command.CommandSender sender, String label, String[] args)	This method is called whenever the sub command is run, return the message (+ chat color if it should not be the default chat color)
void	onTabComplete(List<String> options, org.bukkit.command.CommandSender sender, String label, String[] args)
static void	setupHelp()

Methods inherited from class com.booksaw.betterTeams.commands.SubCommand

addMetaStringList, addPlayerStringList, addTeamStringList, addTeamStringList, checkAsync, getArgMessage, getCommandAndArgMessage, getHelpMessage, needPlayer, runAsync

Methods inherited from class java.lang.Object

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

Field Details

prefix

public static String prefix

description

public static String description

Constructor Details

HelpCommand

public HelpCommand(ParentCommand command)

Method Details

setupHelp

public static void setupHelp()

onCommand

public CommandResponse onCommand(org.bukkit.command.CommandSender sender,
 String label,
 String[] args)

Description copied from class: SubCommand

This method is called whenever the sub command is run, return the message (+ chat color if it should not be the default chat color)

The return value should be the value of the message to be sent to the user, for more complicated messaging systems return null

Specified by:

onCommand in class SubCommand

Parameters:

sender - the person who called the command

label - the label of the initial command (useful for help files)

args - the arguments of the sub command (starting at args[0], as the sub command itself will be removed)

Returns:

the message

fullyCustom

public void fullyCustom(org.bukkit.command.CommandSender sender,
 String label)

Used to send a fully custom help message which is stored in a file

Parameters:

sender - the CommandSender that called the help message

label - the label for the message (the base command for example for /teamadmin it could be /teama as well)

createHelpMessage

public String createHelpMessage(String label,
 String commandPath,
 String description)

Used to create a formatted help message to explain what a command does to the user

Parameters:

label - the base command

commandPath - the rest of the command (i.e. help [param])

description - the description of the command

Returns:

the created message relating to that command

createClickableHelpMessage

public net.md_5.bungee.api.chat.TextComponent createClickableHelpMessage(String label,
 String commandPath,
 String description)

createClickableHelpMiniMessage

public net.kyori.adventure.text.Component createClickableHelpMiniMessage(String label,
 String commandPath,
 String description)

getCommand

public String getCommand()

Specified by:

getCommand in class SubCommand

Returns:

the sub-command which this class handles

getNode

public String getNode()

Specified by:

getNode in class SubCommand

Returns:

the permission node for that sub command

getHelp

public String getHelp()

Specified by:

getHelp in class SubCommand

Returns:

the help information for that sub command (this does not include the arguments)

getArguments

public String getArguments()

Specified by:

getArguments in class SubCommand

Returns:

the arguments for that sub command ie '[name]'

getMinimumArguments

public int getMinimumArguments()

Description copied from class: SubCommand

Used to get the minimum number of arguments which need to be parsed into this command

Specified by:

getMinimumArguments in class SubCommand

Returns:

the number of minimum arguments

onTabComplete

public void onTabComplete(List<String> options,
 org.bukkit.command.CommandSender sender,
 String label,
 String[] args)

Specified by:

onTabComplete in class SubCommand

getMaximumArguments

public int getMaximumArguments()

Description copied from class: SubCommand

return -1 if there is no cap

Specified by:

getMaximumArguments in class SubCommand

Returns:

the maximum number of arguments for the command