dan200.computercraft.api.turtle.event

Class TurtleActionEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

dan200.computercraft.api.turtle.event.TurtleEvent

dan200.computercraft.api.turtle.event.TurtleActionEvent

Direct Known Subclasses:

TurtlePlayerEvent

public class TurtleActionEvent
extends TurtleEvent

An event fired when a turtle is performing a known action.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.fml.common.eventhandler.Event.HasResult, net.minecraftforge.fml.common.eventhandler.Event.Result

Constructor Summary

Constructors

Constructor and Description
TurtleActionEvent(ITurtleAccess turtle, TurtleAction action)

Method Summary

Modifier and Type	Method and Description
TurtleAction	getAction()
java.lang.String	getFailureMessage() Get the message with which this will fail.
void	setCanceled(boolean cancel) Deprecated. Use setCanceled(boolean, String) instead.
void	setCanceled(boolean cancel, java.lang.String failureMessage) Set the cancellation state of this action, setting a failure message if required.

Methods inherited from class dan200.computercraft.api.turtle.event.TurtleEvent

getTurtle

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

TurtleActionEvent

public TurtleActionEvent(@Nonnull
                         ITurtleAccess turtle,
                         @Nonnull
                         TurtleAction action)

Method Detail

getAction

public TurtleAction getAction()

setCanceled

@Deprecated
public void setCanceled(boolean cancel)

Deprecated. Use setCanceled(boolean, String) instead.

Sets the cancellation state of this action. If cancel is true, this action will not be carried out.

Overrides:

setCanceled in class net.minecraftforge.fml.common.eventhandler.Event

Parameters:

cancel - The new canceled value.

See Also:

TurtleCommandResult.failure()

setCanceled

public void setCanceled(boolean cancel,
                        @Nullable
                        java.lang.String failureMessage)

Set the cancellation state of this action, setting a failure message if required. If cancel is true, this action will not be carried out.

Parameters:

cancel - The new canceled value.

failureMessage - The message to return to the user explaining the failure.

See Also:

TurtleCommandResult.failure(String)

getFailureMessage

@Nullable
public java.lang.String getFailureMessage()

Get the message with which this will fail.

Returns:

The failure message.

See Also:

TurtleCommandResult.failure(), setCanceled(boolean, String)