34 lines
1.3 KiB
Java
34 lines
1.3 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2021. This API may be redistributed unmodified and in full only.
|
|
* For help using the API, and posting your mods, visit the forums at computercraft.info.
|
|
*/
|
|
package dan200.computercraft.api.turtle;
|
|
|
|
import javax.annotation.Nonnull;
|
|
|
|
/**
|
|
* An interface for objects executing custom turtle commands, used with {@link ITurtleAccess#executeCommand(ITurtleCommand)}.
|
|
*
|
|
* @see ITurtleAccess#executeCommand(ITurtleCommand)
|
|
*/
|
|
@FunctionalInterface
|
|
public interface ITurtleCommand
|
|
{
|
|
/**
|
|
* Will be called by the turtle on the main thread when it is time to execute the custom command.
|
|
*
|
|
* The handler should either perform the work of the command, and return success, or return
|
|
* failure with an error message to indicate the command cannot be executed at this time.
|
|
*
|
|
* @param turtle Access to the turtle for whom the command was issued.
|
|
* @return A result, indicating whether this action succeeded or not.
|
|
* @see ITurtleAccess#executeCommand(ITurtleCommand)
|
|
* @see TurtleCommandResult#success()
|
|
* @see TurtleCommandResult#failure(String)
|
|
* @see TurtleCommandResult
|
|
*/
|
|
@Nonnull
|
|
TurtleCommandResult execute( @Nonnull ITurtleAccess turtle );
|
|
}
|