Class Specify

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.Specify

public class Specify
extends BaseCommand

Implements the command to specify a structure for the StructureSpecificationManager.

For example, when a player wants to perform an action on a structure, but multiple structures fit the criteria. The Specify command is then used to specify which structure the player wants to perform the action on.

The specify command takes a String as input, which is then used to specify the structure. See StructureSpecificationManager.handleInput(IPlayer, String).

Field Summary

Fields inherited from class BaseCommand

executor, localizer

Method Summary

Modifier and Type	Method	Description
protected boolean	availableForNonPlayers()	Checks if this BaseCommand is available for non-IPlayers (e.g. the server).
protected CompletableFuture<?>	executeCommand(@Nullable PermissionsStatus permissions)	Executes the command.
CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
@NonNull String	toString()

Methods inherited from class BaseCommand

availableForPlayers, getCommandSender, getStructure, hasAccessToAttribute, hasPermission, run, runWithRawResult, runWithRawResult, sendGenericErrorMessage, startExecution, validateInput

Methods inherited from class Object

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

Method Details

getCommand

public CommandDefinition getCommand()

Description copied from class: BaseCommand

Gets the CommandDefinition that contains the definition of this BaseCommand.

Specified by:

getCommand in class BaseCommand

Returns:

The CommandDefinition that contains the definition of this BaseCommand.

availableForNonPlayers

protected boolean availableForNonPlayers()

Description copied from class: BaseCommand

Checks if this BaseCommand is available for non-IPlayers (e.g. the server).

Overrides:

availableForNonPlayers in class BaseCommand

Returns:

True if a non-IPlayer can execute this command.

executeCommand

protected CompletableFuture<?> executeCommand(@Nullable PermissionsStatus permissions)

Description copied from class: BaseCommand

Executes the command. This method is only called if BaseCommand.validateInput() and BaseCommand.hasPermission() are true.

Note that this method is called asynchronously.

Specified by:

executeCommand in class BaseCommand

Parameters:

permissions - Whether the ICommandSender has user and/or admin permissions.

Returns:

The future of the command execution.

toString

public @NonNull String toString()

Overrides:

toString in class BaseCommand