Package nl.pim16aap2.animatedarchitecture.core.commands

Class SetOpenDirectionDelayed

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.DelayedCommand<MovementDirection>

nl.pim16aap2.animatedarchitecture.core.commands.SetOpenDirectionDelayed

@Singleton
public class SetOpenDirectionDelayed
extends DelayedCommand<MovementDirection>

Delayed version of SetOpenDirection.

This command is used to set the opening direction of a structure.

The opening direction can be provided as delayed input.

Nested Class Summary

Nested classes/interfaces inherited from class nl.pim16aap2.animatedarchitecture.core.commands.DelayedCommand

DelayedCommand.Context

Field Summary

Fields inherited from class nl.pim16aap2.animatedarchitecture.core.commands.DelayedCommand

commandFactory, delayedCommandInputManager, inputRequestFactory, localizer, textFactory

Constructor Summary

Constructors

Constructor	Description
SetOpenDirectionDelayed(DelayedCommand.Context context, DelayedCommandInputRequest.IFactory<MovementDirection> inputRequestFactory)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<?>	delayedInputExecutor(ICommandSender commandSender, StructureRetriever structureRetriever, MovementDirection openDir)	The method that is run once delayed input is received.
protected CommandDefinition	getCommandDefinition()
protected String	inputRequestMessage(ICommandSender commandSender, StructureRetriever structureRetriever)	Retrieves the message that will be sent to the command sender after initialization of a delayed input request.

Methods inherited from class nl.pim16aap2.animatedarchitecture.core.commands.DelayedCommand

provideDelayedInput, runDelayed, runDelayed

Methods inherited from class java.lang.Object

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

Constructor Details

SetOpenDirectionDelayed

@Inject
public SetOpenDirectionDelayed(DelayedCommand.Context context,
 DelayedCommandInputRequest.IFactory<MovementDirection> inputRequestFactory)

Method Details

getCommandDefinition

protected CommandDefinition getCommandDefinition()

Specified by:

getCommandDefinition in class DelayedCommand<MovementDirection>

delayedInputExecutor

protected CompletableFuture<?> delayedInputExecutor(ICommandSender commandSender,
 StructureRetriever structureRetriever,
 MovementDirection openDir)

Description copied from class: DelayedCommand

The method that is run once delayed input is received.

It processes the new input and executes the command using the previously-provided data (see DelayedCommand.runDelayed(ICommandSender, StructureRetriever)).

Specified by:

delayedInputExecutor in class DelayedCommand<MovementDirection>

Parameters:

commandSender - The entity that sent the command and is held responsible (i.e. permissions, communication) for its execution.

structureRetriever - A StructureRetrieverFactory that references the target structure.

openDir - The delayed input that was retrieved.

Returns:

See BaseCommand.run().

inputRequestMessage

protected String inputRequestMessage(ICommandSender commandSender,
 StructureRetriever structureRetriever)

Description copied from class: DelayedCommand

Retrieves the message that will be sent to the command sender after initialization of a delayed input request.

Specified by:

inputRequestMessage in class DelayedCommand<MovementDirection>

Parameters:

commandSender - The user responsible for the delayed command.

structureRetriever - The structure retriever as currently specified.

Returns:

The init message for the delayed input request.