2019-01-01 01:10:18 +00:00
|
|
|
/*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
2018-02-16 10:33:32 +00:00
|
|
|
package dan200.computercraft.api.turtle.event;
|
|
|
|
|
|
|
|
import dan200.computercraft.api.turtle.ITurtleAccess;
|
|
|
|
import dan200.computercraft.api.turtle.TurtleCommandResult;
|
Update CC: Tweaked to 1.13
Look, I originally had this split into several commits, but lots of
other cleanups got mixed in. I then backported some of the cleanups to
1.12, did other tidy ups there, and eventually the web of merges was
unreadable.
Yes, this is a horrible mess, but it's still nicer than it was. Anyway,
changes:
- Flatten everything. For instance, there are now three instances of
BlockComputer, two BlockTurtle, ItemPocketComputer. There's also no
more BlockPeripheral (thank heavens) - there's separate block classes
for each peripheral type.
- Remove pretty much all legacy code. As we're breaking world
compatibility anyway, we can remove all the code to load worlds from
1.4 days.
- The command system is largely rewriten to take advantage of 1.13's
new system. It's very fancy!
- WidgetTerminal now uses Minecraft's "GUI listener" system.
- BREAKING CHANGE: All the codes in keys.lua are different, due to the
move to LWJGL 3. Hopefully this won't have too much of an impact.
I don't want to map to the old key codes on the Java side, as there
always ends up being small but slight inconsistencies. IMO it's
better to make a clean break - people should be using keys rather
than hard coding the constants anyway.
- commands.list now allows fetching sub-commands. The ROM has already
been updated to allow fancy usage such as commands.time.set("noon").
- Turtles, modems and cables can be waterlogged.
2019-04-02 12:27:27 +00:00
|
|
|
import net.minecraftforge.eventbus.api.Cancelable;
|
2018-02-16 10:33:32 +00:00
|
|
|
|
|
|
|
import javax.annotation.Nonnull;
|
|
|
|
import javax.annotation.Nullable;
|
2018-12-17 21:33:49 +00:00
|
|
|
import java.util.Objects;
|
2018-02-16 10:33:32 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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 );
|
|
|
|
|
2018-12-17 21:33:49 +00:00
|
|
|
Objects.requireNonNull( action, "action cannot be null" );
|
2018-02-16 10:33:32 +00:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|