Package nl.pim16aap2.animatedarchitecture.core.commands

Class NewStructure

java.lang.Object

nl.pim16aap2.animatedarchitecture.core.commands.BaseCommand

nl.pim16aap2.animatedarchitecture.core.commands.NewStructure

public class NewStructure
extends BaseCommand

Represents the command that is used to create new structures.

Field Summary

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

localizer, textFactory

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(PermissionsStatus permissions)	Executes the command.
CommandDefinition	getCommand()	Gets the CommandDefinition that contains the definition of this BaseCommand.
protected CompletableFuture<PermissionsStatus>	hasPermission()	Checks if the ICommandSender has the required permissions to use this command.
String	toString()

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

availableForPlayers, getCommandSender, getStructure, hasAccessToAttribute, run, startExecution, validInput

Methods inherited from class java.lang.Object

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

Method Details

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.

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.

executeCommand

protected CompletableFuture<?> executeCommand(PermissionsStatus permissions)

Description copied from class: BaseCommand

Executes the command. This method is only called if BaseCommand.validInput() 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.

hasPermission

protected CompletableFuture<PermissionsStatus> hasPermission()

Description copied from class: BaseCommand

Checks if the ICommandSender has the required permissions to use this command. See CommandDefinition.getUserPermission() and CommandDefinition.getAdminPermission().

Overrides:

hasPermission in class BaseCommand

Returns:

A pair of booleans that indicates whether the user has access to the user and admin permission nodes respectively. For both, true indicates that they do have access to the node and false that they do not.

toString

public String toString()

Overrides:

toString in class BaseCommand