Improved CustomGoal

eco-api/src/main/java/com/willfp/eco/core/entities/ai/goals/CustomGoal.java

@@ -0,0 +1,57 @@
+package com.willfp.eco.core.entities.ai.goals;
+
+import org.bukkit.entity.Mob;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Base interface for all custom goals.
+ * <p>
+ * Can be used both for entity goals and target goals.
+ */
+public interface CustomGoal extends EntityGoal, TargetGoal {
+    /**
+     * Initialize the goal with a mob.
+     * <p>
+     * This will be run before any implementation code, treat this as the constructor.
+     *
+     * @param mob The mob.
+     */
+    void initialize(@NotNull Mob mob);
+
+    /**
+     * Get if the goal can be used.
+     * Will start the goal if this returns true.
+     *
+     * @return If the goal can be used.
+     */
+    boolean canUse();
+
+    /**
+     * Tick the goal.
+     * <p>
+     * Runs ever tick as long as {@link this#canUse()} returns true.
+     * <p>
+     * Runs after {@link this#start()}.
+     */
+    default void tick() {
+        // Override when needed.
+    }
+
+    /**
+     * Start the goal.
+     * <p>
+     * Runs once {@link this#canUse()} returns true.
+     */
+    default void start() {
+        // Override when needed.
+    }
+
+    /**
+     * Stop the goal.
+     * <p>
+     * Runs once {@link this#canUse()} returns false.
+     */
+    default void stop() {
+        // Override when needed.
+    }
+}