83 lines
2.4 KiB
Java
83 lines
2.4 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2019. 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.event;
|
|
|
|
import dan200.computercraft.api.turtle.ITurtleAccess;
|
|
import dan200.computercraft.api.turtle.TurtleCommandResult;
|
|
import net.minecraftforge.eventbus.api.Cancelable;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
import java.util.Objects;
|
|
|
|
/**
|
|
* An event fired when a turtle is performing a known action.
|
|
*/
|
|
@Cancelable
|
|
public class TurtleActionEvent extends TurtleEvent
|
|
{
|
|
private final TurtleAction action;
|
|
private String failureMessage;
|
|
|
|
public TurtleActionEvent( @Nonnull ITurtleAccess turtle, @Nonnull TurtleAction action )
|
|
{
|
|
super( turtle );
|
|
|
|
Objects.requireNonNull( action, "action cannot be null" );
|
|
this.action = action;
|
|
}
|
|
|
|
public TurtleAction getAction()
|
|
{
|
|
return action;
|
|
}
|
|
|
|
/**
|
|
* Sets the cancellation state of this action.
|
|
*
|
|
* If {@code cancel} is {@code true}, this action will not be carried out.
|
|
*
|
|
* @param cancel The new canceled value.
|
|
* @see TurtleCommandResult#failure()
|
|
* @deprecated Use {@link #setCanceled(boolean, String)} instead.
|
|
*/
|
|
@Override
|
|
@Deprecated
|
|
public void setCanceled( boolean cancel )
|
|
{
|
|
setCanceled( cancel, null );
|
|
}
|
|
|
|
/**
|
|
* Set the cancellation state of this action, setting a failure message if required.
|
|
*
|
|
* If {@code cancel} is {@code true}, this action will not be carried out.
|
|
*
|
|
* @param cancel The new canceled value.
|
|
* @param failureMessage The message to return to the user explaining the failure.
|
|
* @see TurtleCommandResult#failure(String)
|
|
*/
|
|
public void setCanceled( boolean cancel, @Nullable String failureMessage )
|
|
{
|
|
super.setCanceled( cancel );
|
|
this.failureMessage = cancel ? failureMessage : null;
|
|
}
|
|
|
|
/**
|
|
* Get the message with which this will fail.
|
|
*
|
|
* @return The failure message.
|
|
* @see TurtleCommandResult#failure()
|
|
* @see #setCanceled(boolean, String)
|
|
*/
|
|
@Nullable
|
|
public String getFailureMessage()
|
|
{
|
|
return failureMessage;
|
|
}
|
|
}
|