Class SetBlocksToMove

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.StructureTargetCommand

nl.pim16aap2.animatedarchitecture.core.commands.SetBlocksToMove

public class SetBlocksToMove
extends StructureTargetCommand

Represents the command that is used to change the number of blocks a block will try to move.

Nested Class Summary

Nested classes/interfaces inherited from class StructureTargetCommand

StructureTargetCommand.StructureDescription

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandDefinition	COMMAND_DEFINITION

Fields inherited from class StructureTargetCommand

structureAttribute, structureRetriever

Fields inherited from class BaseCommand

executor, localizer

Method Summary

Modifier and Type	Method	Description
CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
protected List<Property<?>>	getRequiredProperties()	Gets all required properties for this command.
protected void	handleDatabaseActionSuccess(@Nullable Structure retrieverResult)	Called by StructureTargetCommand.handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action was successful.
protected void	notifyMissingProperties(Structure structure)	Notifies the ICommandSender that the targeted Structure is missing required properties.
protected CompletableFuture<?>	performAction(Structure structure)	Performs the action of this command on the Structure.
@NonNull String	toString()

Methods inherited from class StructureTargetCommand

executeCommand, getRetrievedStructureDescription, getRetrievedStructureDescription, getRetrieverResult, getStructureAttribute, getStructureRetriever, handleDatabaseActionCancelled, handleDatabaseActionFail, handleDatabaseActionResult, hasRequiredProperties, isAllowed, sendUpdatedInfo

Methods inherited from class BaseCommand

availableForNonPlayers, 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

Field Details

COMMAND_DEFINITION

public static final CommandDefinition COMMAND_DEFINITION

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.

handleDatabaseActionSuccess

protected void handleDatabaseActionSuccess(@Nullable Structure retrieverResult)

Description copied from class: StructureTargetCommand

Called by StructureTargetCommand.handleDatabaseActionResult(DatabaseManager.ActionResult, Structure) when the database action was successful.

Overrides:

handleDatabaseActionSuccess in class StructureTargetCommand

notifyMissingProperties

protected void notifyMissingProperties(Structure structure)

Description copied from class: StructureTargetCommand

Notifies the ICommandSender that the targeted Structure is missing required properties.

Overrides:

notifyMissingProperties in class StructureTargetCommand

Parameters:

structure - The Structure that is missing the required properties.

performAction

protected CompletableFuture<?> performAction(Structure structure)

Description copied from class: StructureTargetCommand

Performs the action of this command on the Structure.

Specified by:

performAction in class StructureTargetCommand

Parameters:

structure - The Structure to perform the action on.

Returns:

The future of the command execution.

getRequiredProperties

protected List<Property<?>> getRequiredProperties()

Description copied from class: StructureTargetCommand

Gets all required properties for this command.

If targeted structure does not have all required properties, the command will not be executed.

By default, this returns an empty list. Subclasses that require specific properties should override this method.

Overrides:

getRequiredProperties in class StructureTargetCommand

Returns:

A list of all required properties.

toString

public @NonNull String toString()

Overrides:

toString in class StructureTargetCommand