gradle=7.1.1, gradle migrateMappings

remappedSrc/dan200/computercraft/api/turtle/event/TurtleEvent.java

@@ -0,0 +1,52 @@
+/*
+ * 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.event;
+
+import com.google.common.eventbus.EventBus;
+import dan200.computercraft.api.turtle.ITurtleAccess;
+
+import javax.annotation.Nonnull;
+import java.util.Objects;
+
+/**
+ * A base class for all events concerning a turtle. This will only ever constructed and fired on the server side, so sever specific methods on {@link
+ * ITurtleAccess} are safe to use.
+ *
+ * You should generally not need to subscribe to this event, preferring one of the more specific classes.
+ *
+ * @see TurtleActionEvent
+ */
+public abstract class TurtleEvent
+{
+    public static final EventBus EVENT_BUS = new EventBus();
+
+    private final ITurtleAccess turtle;
+
+    protected TurtleEvent( @Nonnull ITurtleAccess turtle )
+    {
+        Objects.requireNonNull( turtle, "turtle cannot be null" );
+        this.turtle = turtle;
+    }
+
+    public static boolean post( TurtleActionEvent event )
+    {
+        EVENT_BUS.post( event );
+        return event.isCancelled();
+    }
+
+    /**
+     * Get the turtle which is performing this action.
+     *
+     * @return The access for this turtle.
+     */
+    @Nonnull
+    public ITurtleAccess getTurtle()
+    {
+        return turtle;
+    }
+
+}