Package nl.pim16aap2.animatedarchitecture.core.commands

@NonNullByDefault package nl.pim16aap2.animatedarchitecture.core.commands

This package contains command definitions and command factories used by this project, as well as various base command classes and interfaces.

Construction of new commands is handled by the CommandFactory, when can be obtained using IAnimatedArchitecturePlatform.getCommandFactory().

A command is not executed directly when it is created. To execute a command, you must call BaseCommand.run() on it. For example:

 public void setBlocksToMove(
     CommandFactory commandFactory, ICommandSender commandSender, StructureRetriever retriever, int blocksToMove)
 {
     commandFactory
         .newSetBlocksToMove(commandSender, retriever, blocksToMove)
         .run()
         .exceptionally(ex -> ...);
 }

For situations where not all required data is available, the 'Delayed' version of the command can be used. For example, when a player selects the option to change the 'blocksToMove' value of a portcullis in the GUI. In this situation, you only know the target structure, but not yet the new 'blocksToMove' value. The SetBlocksToMoveDelayed command can then be used to request the player to specify the new value.

For example:

invalid input: '{@code
 public void setBlocksToMoveDelayed(
     CommandFactory commandFactory, ICommandSender commandSender, StructureRetriever retriever)
 {
     commandFactory
         .getSetBlocksToMoveDelayed()
         .runDelayed(commandSender, retriever)
         .exceptionally(ex -> ...);
 }</pre>'

Class	Description
AddOwner	Represents the command that adds co-owners to a given structure.
AddOwnerDelayed	Delayed version of AddOwner.
AddOwnerDelayed.DelayedInput	Represents the data that can be provided as delayed input for this command.
BaseCommand	Represents the base AnimatedArchitecture command.
Cancel	Represents the cancel command, which cancels any processes waiting for user input (e.g. structure creation).
CommandDefinition	Represents the various commands that are used along with their user/admin permission nodes.
CommandFactory	Represents a factory for commands.
Confirm	Represents the confirm command, which is used to confirm actions AnimatedArchitecture is waiting on.
Debug	Represents the debug command.
DelayedCommand<T>	Represents a delayed command.
DelayedCommand.Context
DelayedCommandInputRequest<T>	Represents a request for delayed additional input for a command.
DelayedCommandInputRequest.IFactory<T>
Delete	Represents the command that is used to delete structures.
ICommandSender
Info	Represents the information command that provides the issuer with more information about the structure.
InspectPowerBlock	Represents the command to inspect a location to check if there are any powerblocks registered there.
IServer	Represents the server as an ICommandSender
ListStructures	Represents a command to list a number of structures matching a single StructureRetrieverFactory.
Lock	Represents the command that is used to change whether a structure is locked.
Menu	Represents the menu command, which is used to open the menu for a user.
MovePowerBlock	Represents the command to initiate the process to move the powerblock of a structure to a different location.
NewStructure	Represents the command that is used to create new structures.
PermissionsStatus	Represents a pair of booleans that determine whether a user has user-level and/or admin-level permission access to some kind of action.
RemoveOwner	Represents the remove owner command.
RemoveOwnerDelayed	Delayed version of RemoveOwner.
Restart	Represents the command that is used to restart AnimatedArchitecture.
SetBlocksToMove	Represents the command that is used to change the number of blocks a block will try to move.
SetBlocksToMoveDelayed	Delayed version of SetBlocksToMove.
SetName	Represents the setName command, which is used to provide a name for a ToolUser.
SetOpenDirection	Represents the command that changes the opening direction of structures.
SetOpenDirectionDelayed	Delayed version of SetOpenDirection.
SetOpenStatus	Represents the command that changes the opening status of structures.
SetOpenStatusDelayed	Delayed version of SetOpenStatus.
Specify	Implements the command to specify a structure for the StructureSpecificationManager.
StopStructures	Represents the command used to stop all active structures.
StructureTargetCommand	Represents a command that relates to an existing structure.
StructureTargetCommand.StructureDescription	A simple description of a structure.
UpdateCreator	Represents a command that is used to update active Creator processes with arbitrary data in out-of-procedure order.
UpdateCreator.IFactory
Version	Represents the command that shows the ICommandSender the current version of the plugin that is running.