Package dan200.computercraft.api.turtle

Class TurtleCommandResult

java.lang.Object

dan200.computercraft.api.turtle.TurtleCommandResult

public final class TurtleCommandResult
extends Object

Used to indicate the result of executing a turtle command.

See Also:

• TurtleCommand.execute(ITurtleAccess)
• ITurtleUpgrade.useTool(ITurtleAccess, TurtleSide, TurtleVerb, Direction)

Method Summary

Modifier and Type	Method	Description
static TurtleCommandResult	failure()	Create a failed command result with no error message.
static TurtleCommandResult	failure(@Nullable String errorMessage)	Create a failed command result with an error message.
@Nullable String	getErrorMessage()	Get the error message of this command result.
@Nullable Object @Nullable []	getResults()	Get the resulting values of this command result.
boolean	isSuccess()	Determine whether the command executed successfully.
static TurtleCommandResult	success()	Create a successful command result with no result.
static TurtleCommandResult	success(@Nullable Object[] results)	Create a successful command result with the given result values.

Methods inherited from class java.lang.Object

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

Method Details

success

public static TurtleCommandResult success()

Create a successful command result with no result.

Returns:

A successful command result with no values.

success

public static TurtleCommandResult success(@Nullable Object[] results)

Create a successful command result with the given result values.

Parameters:

results - The results of executing this command.

Returns:

A successful command result with the given values.

failure

public static TurtleCommandResult failure()

Create a failed command result with no error message.

Returns:

A failed command result with no message.

failure

public static TurtleCommandResult failure(@Nullable String errorMessage)

Create a failed command result with an error message.

Parameters:

errorMessage - The error message to provide.

Returns:

A failed command result with a message.

isSuccess

public boolean isSuccess()

Determine whether the command executed successfully.

Returns:

If the command was successful.

getErrorMessage

public @Nullable String getErrorMessage()

Get the error message of this command result.

Returns:

The command's error message, or null if it was a success.

getResults

public @Nullable Object @Nullable [] getResults()

Get the resulting values of this command result.

Returns:

The command's result, or null if it was a failure.