Added callbacks, and an event for expiring summons

Author: jamailun

api/src/main/java/fr/jamailun/ultimatespellsystem/api/events/SummonedEntityExpiredEvent.java

@@ -0,0 +1,24 @@
+package fr.jamailun.ultimatespellsystem.api.events;
+
+import fr.jamailun.ultimatespellsystem.api.entities.SummonAttributes;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Event called when a summoned entity expired.
+ */
+@RequiredArgsConstructor
+@Getter
+public class SummonedEntityExpiredEvent extends Event {
+
+    @NotNull
+    private final SummonAttributes summon;
+
+    private static final HandlerList HANDLERS = new HandlerList();
+    @Override
+    public @NotNull HandlerList getHandlers() {return HANDLERS;}
+    public static HandlerList getHandlerList() {return HANDLERS;}
+}

plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/ExtensionLoader.java

@@ -4,7 +4,9 @@
 import fr.jamailun.ultimatespellsystem.api.providers.CallbackEventProvider;
 import fr.jamailun.ultimatespellsystem.api.providers.JavaFunctionProvider;
 import fr.jamailun.ultimatespellsystem.extension.callbacks.CallbackProvider;
-import fr.jamailun.ultimatespellsystem.extension.callbacks.ProjectileLandListener;
+import fr.jamailun.ultimatespellsystem.extension.callbacks.EntityDeathCallbacks;
+import fr.jamailun.ultimatespellsystem.extension.callbacks.SummonExpiresCallbacks;
+import fr.jamailun.ultimatespellsystem.extension.callbacks.ProjectileLandCallbacks;
 import fr.jamailun.ultimatespellsystem.extension.functions.*;
 import fr.jamailun.ultimatespellsystem.extension.providers.*;
 import org.bukkit.Bukkit;
@@ -57,14 +59,18 @@ public static void loadCallbacks(JavaPlugin plugin) {
         UltimateSpellSystem.logInfo("Loading extension callbacks.");
 
         // Load elements
-        loadCallback(plugin, new ProjectileLandListener());
+        loadCallback(plugin, new ProjectileLandCallbacks());
+        loadCallback(plugin, new EntityDeathCallbacks());
+        loadCallback(plugin, new SummonExpiresCallbacks());
+
+        UltimateSpellSystem.logInfo("Loaded extension callbacks.");
     }
 
     private static void loadCallback(JavaPlugin plugin, CallbackProvider<?> callbackProvider) {
         // 1. Event
         Bukkit.getPluginManager().registerEvents(callbackProvider, plugin);
         // 2. Register
-        CallbackEventProvider.instance().registerCallback(callbackProvider.getCallback());
+        callbackProvider.getCallbacks().forEach(CallbackEventProvider.instance()::registerCallback);
     }
 
 }

plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/CallbackProvider.java

@@ -6,9 +6,11 @@
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collection;
+
 public abstract class CallbackProvider<E extends Event> implements Listener {
 
     @Contract("-> new")
-    public abstract @NotNull CallbackAction<E, ?> getCallback();
+    public abstract @NotNull Collection<CallbackAction<E, ?>> getCallbacks();
 
 }

plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/EntityDeathCallbacks.java

@@ -0,0 +1,37 @@
+package fr.jamailun.ultimatespellsystem.extension.callbacks;
+
+import fr.jamailun.ultimatespellsystem.api.UltimateSpellSystem;
+import fr.jamailun.ultimatespellsystem.api.entities.CallbackAction;
+import fr.jamailun.ultimatespellsystem.api.entities.SummonAttributes;
+import fr.jamailun.ultimatespellsystem.dsl.objects.CallbackEvent;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.entity.EntityDeathEvent;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * Used by {@code LAND} callbacks.
+ */
+public class EntityDeathCallbacks extends CallbackProvider<EntityDeathEvent> {
+
+    @EventHandler
+    void onEvent(@NotNull EntityDeathEvent event) {
+        SummonAttributes summon = UltimateSpellSystem.getSummonsManager().find(event.getEntity().getUniqueId());
+        if(summon == null) return;
+        summon.applyCallback(event);
+    }
+
+    @Override
+    public @NotNull Collection<CallbackAction<EntityDeathEvent, ?>> getCallbacks() {
+        return List.of(
+                new CallbackAction<>(
+                    CallbackEvent.of("die"),
+                    EntityDeathEvent.class,
+                    x -> null
+                )
+        );
+    }
+
+}

…on/callbacks/ProjectileLandListener.java …n/callbacks/ProjectileLandCallbacks.javaplugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/ProjectileLandListener.java renamed to plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/ProjectileLandCallbacks.java plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/ProjectileLandListener.java renamed to plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/ProjectileLandCallbacks.java

@@ -6,30 +6,38 @@
 import fr.jamailun.ultimatespellsystem.dsl.nodes.type.TypePrimitive;
 import fr.jamailun.ultimatespellsystem.dsl.objects.CallbackEvent;
 import fr.jamailun.ultimatespellsystem.dsl.tokenization.TokenType;
-import org.bukkit.Location;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.entity.ProjectileHitEvent;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collection;
+import java.util.List;
+
 /**
  * Used by {@code LAND} callbacks.
  */
-public class ProjectileLandListener extends CallbackProvider<ProjectileHitEvent> {
+public class ProjectileLandCallbacks extends CallbackProvider<ProjectileHitEvent> {
 
     @EventHandler
-    void onProjectileLand(@NotNull ProjectileHitEvent event) {
-        if(event.getHitBlock() == null) return;
+    void onEvent(@NotNull ProjectileHitEvent event) {
         SummonAttributes summon = UltimateSpellSystem.getSummonsManager().find(event.getEntity().getUniqueId());
         if(summon == null) return;
         summon.applyCallback(event);
     }
 
     @Override
-    public @NotNull CallbackAction<ProjectileHitEvent, Location> getCallback() {
-        return new CallbackAction<>(
-                CallbackEvent.of("landed", TokenType.AT, TypePrimitive.LOCATION),
-                ProjectileHitEvent.class,
-                e -> e.getEntity().getLocation()
+    public @NotNull Collection<CallbackAction<ProjectileHitEvent, ?>> getCallbacks() {
+        return List.of(
+                new CallbackAction<>(
+                    CallbackEvent.of("landed", TokenType.AT, TypePrimitive.LOCATION),
+                    ProjectileHitEvent.class,
+                    e -> e.getEntity().getLocation()
+                ),
+                new CallbackAction<>(
+                        CallbackEvent.of("hit", TokenType.TO, TypePrimitive.ENTITY),
+                        ProjectileHitEvent.class,
+                        ProjectileHitEvent::getEntity
+                )
         );
     }
 

plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/callbacks/SummonExpiresCallbacks.java

@@ -0,0 +1,33 @@
+package fr.jamailun.ultimatespellsystem.extension.callbacks;
+
+import fr.jamailun.ultimatespellsystem.api.entities.CallbackAction;
+import fr.jamailun.ultimatespellsystem.api.events.SummonedEntityExpiredEvent;
+import fr.jamailun.ultimatespellsystem.dsl.objects.CallbackEvent;
+import org.bukkit.event.EventHandler;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * Used by {@code LAND} callbacks.
+ */
+public class SummonExpiresCallbacks extends CallbackProvider<SummonedEntityExpiredEvent> {
+
+    @EventHandler
+    void onEvent(@NotNull SummonedEntityExpiredEvent event) {
+        event.getSummon().applyCallback(event);
+    }
+
+    @Override
+    public @NotNull Collection<CallbackAction<SummonedEntityExpiredEvent, ?>> getCallbacks() {
+        return List.of(
+                new CallbackAction<>(
+                    CallbackEvent.of("expire"),
+                    SummonedEntityExpiredEvent.class,
+                    x -> null
+                )
+        );
+    }
+
+}

plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/entities/SummonAttributesImpl.java

@@ -4,9 +4,11 @@
 import fr.jamailun.ultimatespellsystem.api.entities.SummonAttributes;
 import fr.jamailun.ultimatespellsystem.api.entities.UssEntityType;
 import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
+import fr.jamailun.ultimatespellsystem.api.events.SummonedEntityExpiredEvent;
 import fr.jamailun.ultimatespellsystem.api.runner.SpellRuntime;
 import fr.jamailun.ultimatespellsystem.api.providers.SummonPropertiesProvider;
 import fr.jamailun.ultimatespellsystem.dsl.nodes.type.Duration;
+import org.bukkit.Bukkit;
 import org.bukkit.Location;
 import org.bukkit.entity.*;
 import org.bukkit.event.Event;
@@ -89,6 +91,10 @@ public final void summon(Consumer<UUID> callback, SpellRuntime runtime) {
 
         // Start the death timer
         deathTimer = UltimateSpellSystem.runTaskLater(() -> {
+            if(entity.isValid()) {
+                // Called before the remove, so that the entity is still accessible.
+                Bukkit.getPluginManager().callEvent(new SummonedEntityExpiredEvent(this));
+            }
             entity.remove();
             callback.accept(getUUID());
         }, summonDuration.toTicks());