Package sawfowl.commandpack.api.commands

Interface PluginCommand

All Known Subinterfaces:

ParameterizedCommand, ParameterizedPlayerCommand, RawCommand, RawPlayerCommand

public interface PluginCommand

An auxiliary interface for creating commands.

Method Summary

Modifier and Type	Method	Description
default void	checkCooldown(CommandCause cause, Locale locale, boolean isPlayer)
String	command()	The main alias of the command.
static BigDecimal	createDecimal(double value)
default void	delay(ServerPlayer player, Locale locale, sawfowl.commandpack.commands.ThrowingConsumer<PluginCommand,CommandException> consumer)	Code execution delay. Automatically activates the command's execution fee if required by the command's settings.
default void	economy(ServerPlayer player, Locale locale)	Payment for the execution of the command.
default CommandException	exception(String text)	Outputs an error message when the command is executed.
default CommandException	exception(Locale locale, Object... path)	Outputs a localized error message during command execution.
default CommandException	exception(Locale locale, Object[] path, String[] keys, String... values)
default CommandException	exception(Locale locale, Object[] path, String[] keys, Component... values)
default CommandException	exception(Locale locale, Object[] path, String key, String value)
default CommandException	exception(Locale locale, Object[] path, String replaceKey, Component replaceValue)
default CommandException	exception(Component text)	Outputs an error message when the command is executed.
default CommandException	exception(Text text)	Outputs an error message when the command is executed.
Settings	getCommandSettings()	Command settings. This is where you specify the aliases, kooldowns, delays, and price.
Component	getComponent(Object[] path)	Retrieving text from a specified location.
default Component	getComponent(Locale locale, Object... path)	Getting a localized message.
default Component	getComponent(ServerPlayer player, Object[] path)	Getting a localized message for the player.
org.spongepowered.plugin.PluginContainer	getContainer()	PluginContainer to which the command will be registered.
default Map<UUID,Long>	getCooldowns()
default List<Component>	getListTexts(Locale locale, Object... path)
default Locale	getLocale(CommandCause cause)
default <T extends LocaleReference> T	getPluginLocale(Class<T> localeClass, Locale locale)
default Text	getText(Locale locale, Object... path)	Getting a localized message.
default Text	getText(ServerPlayer player, Object[] path)	Getting a localized message for the player.
default boolean	isEnable()
String	permission()	The permission needed to execute the command.
default void	sendPaginationList(Audience target, Component title, Component padding, int linesPerPage, List<Component> components)	Sending a multi-page list of text.
default CommandResult	success()
default Component	text(Object objectToString)
default Component	text(String string)	Serialization of text.
default Component	timeFormat(long second, Locale locale)	Time formatting.
default String	trackingName()	The name of the command for which the last execution time will be checked. For example, commands such as `/day`, `/night` are checked as `/time`. By default, it is unique for each command.

Method Details

getCommandSettings

Settings getCommandSettings()

Command settings.
This is where you specify the aliases, kooldowns, delays, and price.

getComponent

Component getComponent(Object[] path)

Retrieving text from a specified location. You can return null, but in which case you need to create localized messages in LocaleAPI.

getContainer

org.spongepowered.plugin.PluginContainer getContainer()

PluginContainer to which the command will be registered.

permission

String permission()

The permission needed to execute the command.

command

String command()

The main alias of the command.

trackingName

default String trackingName()

The name of the command for which the last execution time will be checked.
For example, commands such as `/day`, `/night` are checked as `/time`.
By default, it is unique for each command. Overriding it may be useful in some situations.

checkCooldown

default void checkCooldown(CommandCause cause,
 Locale locale,
 boolean isPlayer)
                    throws CommandException

Throws:

CommandException

getCooldowns

default Map<UUID,Long> getCooldowns()

getComponent

default Component getComponent(ServerPlayer player,
 Object[] path)

Getting a localized message for the player.

getText

default Text getText(ServerPlayer player,
 Object[] path)

Getting a localized message for the player.

getLocale

default Locale getLocale(CommandCause cause)

getComponent

default Component getComponent(Locale locale,
 Object... path)

Getting a localized message.

getText

default Text getText(Locale locale,
 Object... path)

Getting a localized message.

getListTexts

default List<Component> getListTexts(Locale locale,
 Object... path)

success

default CommandResult success()

text

default Component text(String string)

Serialization of text.

text

default Component text(Object objectToString)

exception

default CommandException exception(Component text)
                            throws CommandException

Outputs an error message when the command is executed.

Throws:

CommandException

exception

default CommandException exception(Text text)
                            throws CommandException

Outputs an error message when the command is executed.

Throws:

CommandException

exception

default CommandException exception(String text)
                            throws CommandException

Outputs an error message when the command is executed.

Throws:

CommandException

exception

default CommandException exception(Locale locale,
 Object... path)
                            throws CommandException

Outputs a localized error message during command execution.

Throws:

CommandException

exception

default CommandException exception(Locale locale,
 Object[] path,
 String replaceKey,
 Component replaceValue)
                            throws CommandException

Throws:

CommandException

exception

default CommandException exception(Locale locale,
 Object[] path,
 String key,
 String value)
                            throws CommandException

Throws:

CommandException

exception

default CommandException exception(Locale locale,
 Object[] path,
 String[] keys,
 String... values)
                            throws CommandException

Throws:

CommandException

exception

default CommandException exception(Locale locale,
 Object[] path,
 String[] keys,
 Component... values)
                            throws CommandException

Throws:

CommandException

timeFormat

default Component timeFormat(long second,
 Locale locale)

Time formatting.

delay

default void delay(ServerPlayer player,
 Locale locale,
 sawfowl.commandpack.commands.ThrowingConsumer<PluginCommand,CommandException> consumer)
            throws CommandException

Code execution delay.
Automatically activates the command's execution fee if required by the command's settings.

Throws:

CommandException

economy

default void economy(ServerPlayer player,
 Locale locale)
              throws CommandException

Payment for the execution of the command.

Throws:

CommandException

createDecimal

static BigDecimal createDecimal(double value)

sendPaginationList

default void sendPaginationList(Audience target,
 Component title,
 Component padding,
 int linesPerPage,
 List<Component> components)

Sending a multi-page list of text.

getPluginLocale

default <T extends LocaleReference> T getPluginLocale(Class<T> localeClass,
 Locale locale)

isEnable

default boolean isEnable()