Reworked the API : cast with a SpellEntity instead of a LivingEntity.

jamailun · jamailun · commit 82959bd4acd9 · 2025-03-25T18:56:35.000+01:00
diff --git a/api/src/main/java/fr/jamailun/ultimatespellsystem/api/entities/SpellEntity.java b/api/src/main/java/fr/jamailun/ultimatespellsystem/api/entities/SpellEntity.java
@@ -54,12 +54,6 @@ default boolean isBukkit() {
      */
     void teleport(@NotNull Location location);
 
-    /**
-     * Send a message to the entity.
-     * @param component component to send.
-     */
-    void sendMessage(Component component);
-
     /**
      * Remove the entity from the game.
      * Will not do anything if already removed.
@@ -72,6 +66,12 @@ default boolean isBukkit() {
      */
     boolean isValid();
 
+    /**
+     * Send a message to the entity. You probably don't want to implement this fully often.
+     * @param component component to send.
+     */
+    void sendMessage(Component component);
+
     /**
      * Add a potion effect.
      * @param effect the potion effect to add. May do nothing.
diff --git a/api/src/main/java/fr/jamailun/ultimatespellsystem/api/entities/SummonAttributes.java b/api/src/main/java/fr/jamailun/ultimatespellsystem/api/entities/SummonAttributes.java
@@ -4,7 +4,6 @@
 import fr.jamailun.ultimatespellsystem.api.utils.AttributesHolder;
 import fr.jamailun.ultimatespellsystem.dsl.nodes.type.Duration;
 import org.bukkit.Location;
-import org.bukkit.entity.LivingEntity;
 import org.bukkit.event.Event;
 import org.bukkit.scheduler.BukkitRunnable;
 import org.jetbrains.annotations.ApiStatus;
@@ -14,8 +13,6 @@
 
 import java.time.Instant;
 import java.util.*;
-import java.util.function.BiConsumer;
-import java.util.function.BiFunction;
 import java.util.function.Consumer;
 
 /**
@@ -38,7 +35,7 @@ public interface SummonAttributes extends AttributesHolder {
      * @return a non-null LivingEntity.
      */
     @Contract(pure = true)
-    @NotNull LivingEntity getSummoner();
+    @NotNull SpellEntity getSummoner();
 
     /**
      * Get the summoned entity.
diff --git a/api/src/main/java/fr/jamailun/ultimatespellsystem/api/events/EntityCastSpellEvent.java b/api/src/main/java/fr/jamailun/ultimatespellsystem/api/events/EntityCastSpellEvent.java
@@ -1,7 +1,7 @@
 package fr.jamailun.ultimatespellsystem.api.events;
 
+import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import fr.jamailun.ultimatespellsystem.api.spells.Spell;
-import org.bukkit.entity.LivingEntity;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.NotNull;
@@ -11,7 +11,7 @@
  */
 public class EntityCastSpellEvent extends Event implements MaybeCancellable {
 
-    private final LivingEntity caster;
+    private final SpellEntity caster;
     private final Spell spell;
     private boolean cancelled = false;
     private final boolean cancellable;
@@ -22,7 +22,7 @@ public class EntityCastSpellEvent extends Event implements MaybeCancellable {
      * @param spell spell to be cast.
      * @param cancellable true if the spell can be cancelled.
      */
-    public EntityCastSpellEvent(@NotNull LivingEntity caster, @NotNull Spell spell, boolean cancellable) {
+    public EntityCastSpellEvent(@NotNull SpellEntity caster, @NotNull Spell spell, boolean cancellable) {
         this.caster = caster;
         this.spell = spell;
         this.cancellable = cancellable;
@@ -40,7 +40,7 @@ public EntityCastSpellEvent(@NotNull LivingEntity caster, @NotNull Spell spell,
      * Get the caster
      * @return the reference to the bukkit caster.
      */
-    public @NotNull LivingEntity getCaster() {
+    public @NotNull SpellEntity getCaster() {
         return caster;
     }
 
diff --git a/api/src/main/java/fr/jamailun/ultimatespellsystem/api/events/EntitySummonedEvent.java b/api/src/main/java/fr/jamailun/ultimatespellsystem/api/events/EntitySummonedEvent.java
@@ -2,7 +2,6 @@
 
 import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import fr.jamailun.ultimatespellsystem.api.entities.SummonAttributes;
-import org.bukkit.entity.LivingEntity;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.NotNull;
@@ -34,7 +33,7 @@ public EntitySummonedEvent(@NotNull SummonAttributes attributes) {
      * Get the entity that has been summoned.
      * @return a non-null bukkit Entity.
      */
-    public @NotNull LivingEntity getSummoner() {
+    public @NotNull SpellEntity getSummoner() {
         return attributes.getSummoner();
     }
 
diff --git a/api/src/main/java/fr/jamailun/ultimatespellsystem/api/runner/SpellRuntime.java b/api/src/main/java/fr/jamailun/ultimatespellsystem/api/runner/SpellRuntime.java
@@ -1,6 +1,6 @@
 package fr.jamailun.ultimatespellsystem.api.runner;
 
-import org.bukkit.entity.LivingEntity;
+import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -16,7 +16,7 @@ public interface SpellRuntime {
      * Get the caster of the current spell.
      * @return a non-null reference to the caster.
      */
-    @NotNull LivingEntity getCaster();
+    @NotNull SpellEntity getCaster();
 
     /**
      * A reference to the variables set.
@@ -70,7 +70,7 @@ public interface SpellRuntime {
      * @return a new instance with a copy of other variables.
      */
     @Contract("_ -> new")
-    @NotNull SpellRuntime makeChildNewCaster(@NotNull LivingEntity newCaster);
+    @NotNull SpellRuntime makeChildNewCaster(@NotNull SpellEntity newCaster);
 
     /**
      * Get the final exit code.
diff --git a/api/src/main/java/fr/jamailun/ultimatespellsystem/api/spells/Spell.java b/api/src/main/java/fr/jamailun/ultimatespellsystem/api/spells/Spell.java
@@ -1,5 +1,6 @@
 package fr.jamailun.ultimatespellsystem.api.spells;
 
+import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import fr.jamailun.ultimatespellsystem.api.events.EntityCastSpellEvent;
 import fr.jamailun.ultimatespellsystem.api.runner.SpellRuntime;
 import fr.jamailun.ultimatespellsystem.api.utils.MultivaluedMap;
@@ -15,22 +16,30 @@ public interface Spell {
 
     /**
      * Cast a spell, in a forceful way. An event will be emitted.
-     * @param caster the living-entity to cast the spell.
+     * @param caster the bukkit living entity, caster of the spell.
      * @return {@code false} if the spell finished with an error.
      * @see EntityCastSpellEvent
      */
-    default boolean castNotCancellable(@NotNull LivingEntity caster) {
+    boolean castNotCancellable(@NotNull LivingEntity caster);
+
+    /**
+     * Cast a spell, in a forceful way. An event will be emitted.
+     * @param caster the caster of the spell.
+     * @return {@code false} if the spell finished with an error.
+     * @see EntityCastSpellEvent
+     */
+    default boolean castNotCancellable(@NotNull SpellEntity caster) {
         return castNotCancellable(caster, null);
     }
 
     /**
      * Cast a spell, in a forceful way, with a specific runtime. An event will be emitted.
-     * @param caster the living-entity to cast the spell.
+     * @param caster the non-null caster for the spell.
      * @param runtime the runtime to use.
      * @return {@code false} if the spell finished with an error.
      * @see EntityCastSpellEvent
      */
-    boolean castNotCancellable(@NotNull LivingEntity caster, @Nullable SpellRuntime runtime);
+    boolean castNotCancellable(@NotNull SpellEntity caster, @Nullable SpellRuntime runtime);
 
     /**
      * Cast a spell, in a cancellable way. An event will be emitted.
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/functions/AbstractFunction.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/functions/AbstractFunction.java
@@ -7,6 +7,7 @@
 import fr.jamailun.ultimatespellsystem.api.runner.functions.RunnableJavaFunction;
 import fr.jamailun.ultimatespellsystem.dsl.nodes.expressions.functions.FunctionArgument;
 import fr.jamailun.ultimatespellsystem.dsl.nodes.type.Type;
+import fr.jamailun.ultimatespellsystem.plugin.entities.BukkitSpellEntity;
 import org.bukkit.Location;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.LivingEntity;
@@ -33,17 +34,27 @@ protected AbstractFunction(@NotNull String id, @NotNull Type type, @NotNull List
     }
 
     protected @Nullable LivingEntity toLivingEntity(@NotNull String context, @NotNull RuntimeExpression expression, @NotNull SpellRuntime runtime) {
-        Object locationRaw = expression.evaluate(runtime);
-        if(locationRaw instanceof LivingEntity livingEntity) {
+        Object entityRaw = expression.evaluate(runtime);
+        if(entityRaw instanceof LivingEntity livingEntity) {
             return livingEntity;
-        } else if(locationRaw instanceof SpellEntity entity) {
+        } else if(entityRaw instanceof SpellEntity entity) {
             Entity be = entity.getBukkitEntity().orElse(null);
             if(be instanceof LivingEntity le)
                 return le;
             return null;
         } else {
-            throw new InvalidTypeException(context, "location or entity", locationRaw);
+            throw new InvalidTypeException(context, "location or entity", entityRaw);
         }
     }
 
+    protected @Nullable SpellEntity toSpellEntity(@NotNull String context, @NotNull RuntimeExpression expression, @NotNull SpellRuntime runtime) {
+        Object entityRaw = expression.evaluate(runtime);
+        return switch (entityRaw) {
+            case null -> null;
+            case LivingEntity le -> new BukkitSpellEntity(le);
+            case SpellEntity se -> se;
+            default -> throw new InvalidTypeException(context, "location or entity", entityRaw);
+        };
+    }
+
 }
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/functions/CastSpellFunction.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/extension/functions/CastSpellFunction.java
@@ -1,6 +1,7 @@
 package fr.jamailun.ultimatespellsystem.extension.functions;
 
 import fr.jamailun.ultimatespellsystem.api.UltimateSpellSystem;
+import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import fr.jamailun.ultimatespellsystem.api.spells.Spell;
 import fr.jamailun.ultimatespellsystem.api.runner.RuntimeExpression;
 import fr.jamailun.ultimatespellsystem.api.runner.SpellRuntime;
@@ -41,7 +42,7 @@ public CastSpellFunction() {
 
     @Override
     public Object compute(@NotNull List<RuntimeExpression> arguments, @NotNull SpellRuntime runtime) {
-        LivingEntity entity = toLivingEntity("cast(entity)", arguments.getFirst(), runtime);
+        SpellEntity entity = toSpellEntity("cast(entity)", arguments.getFirst(), runtime);
         if(entity == null) return false;
         String spellId = runtime.safeEvaluate(arguments.get(1), String.class);
 
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/entities/SummonAttributesImpl.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/entities/SummonAttributesImpl.java
@@ -12,6 +12,7 @@
 import org.bukkit.Location;
 import org.bukkit.entity.*;
 import org.bukkit.event.Event;
+import org.bukkit.projectiles.ProjectileSource;
 import org.bukkit.scheduler.BukkitRunnable;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -26,7 +27,7 @@
  */
 public class SummonAttributesImpl implements SummonAttributes {
 
-    protected final LivingEntity summoner;
+    protected final SpellEntity summoner;
     protected final Map<String, Object> attributes;
     protected final Location summonLocation;
     protected final UssEntityType summonEntityType;
@@ -44,7 +45,7 @@ public class SummonAttributesImpl implements SummonAttributes {
      * @param attributes properties to use. Implementation-dependent.
      * @param duration the duration of the summoning, after which the creature will be removed.
      */
-    public SummonAttributesImpl(LivingEntity summoner, Location location, UssEntityType type, Map<String, Object> attributes, Duration duration) {
+    public SummonAttributesImpl(SpellEntity summoner, Location location, UssEntityType type, Map<String, Object> attributes, Duration duration) {
         this.summoner = summoner;
         this.summonLocation = location;
         this.summonEntityType = type;
@@ -71,11 +72,16 @@ public final void summon(Consumer<UUID> callback, SpellRuntime runtime) {
         if(summonEntityType.isBukkit()) {
             Entity raw = summonLocation.getWorld().spawnEntity(summonLocation, summonEntityType.getBukkit(), false);
             if(raw instanceof Projectile projectile) {
-                projectile.setShooter(runtime.getCaster());
+                // Set the projectile source... if possible
+                if(runtime.getCaster().getBukkitEntity().orElse(null) instanceof ProjectileSource ps) {
+                    projectile.setShooter(ps);
+                }
+                // Set the pickup status when required.
                 if(projectile instanceof Arrow arrow) {
                     arrow.setPickupStatus(AbstractArrow.PickupStatus.DISALLOWED);
                 }
             }
+            // Always wrap the entity.
             entity = new BukkitSpellEntity(raw);
         } else {
             entity = summonEntityType.generateCustom(this);
@@ -101,7 +107,7 @@ public final void summon(Consumer<UUID> callback, SpellRuntime runtime) {
     }
 
     @Override
-    public @NotNull LivingEntity getSummoner() {
+    public @NotNull SpellEntity getSummoner() {
         return summoner;
     }
 
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/entities/implem/Orb.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/entities/implem/Orb.java
@@ -123,8 +123,12 @@ private void applyEffects(@NotNull Collection<LivingEntity> nearby) {
             // Fire + Damages
             if(fireTicks > 0)
                 nearby.forEach(e -> e.setFireTicks(e.getFireTicks() + fireTicks));
-            if(damages > 0)
-                nearby.forEach(e -> e.damage(damages, getAttributes().getSummoner()));
+            if(damages > 0) {
+                getAttributes().getSummoner().getBukkitEntity().ifPresentOrElse(
+                        summoner -> nearby.forEach(e -> e.damage(damages, summoner)),
+                        () -> nearby.forEach(e -> e.damage(damages))
+                );
+            }
 
             // Hit effect
             hitSound.apply(other.getLocation());
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/listeners/AttackListener.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/listeners/AttackListener.java
@@ -1,9 +1,11 @@
 package fr.jamailun.ultimatespellsystem.plugin.listeners;
 
 import fr.jamailun.ultimatespellsystem.api.UltimateSpellSystem;
+import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import fr.jamailun.ultimatespellsystem.api.spells.Spell;
 import fr.jamailun.ultimatespellsystem.plugin.bind.ItemBinderImpl;
 import fr.jamailun.ultimatespellsystem.api.events.BoundSpellCastEvent;
+import fr.jamailun.ultimatespellsystem.plugin.entities.BukkitSpellEntity;
 import fr.jamailun.ultimatespellsystem.plugin.utils.UssConfig;
 import lombok.RequiredArgsConstructor;
 import org.bukkit.Bukkit;
@@ -40,10 +42,11 @@ private void handle(@NotNull LivingEntity entity, @NotNull ItemStack item, Entit
                 return;
             }
             BoundSpellCastEvent cast = new BoundSpellCastEvent(entity, def, item, BoundSpellCastEvent.Action.ATTACK);
+            SpellEntity caster = new BukkitSpellEntity(entity);
             Bukkit.getPluginManager().callEvent(cast);
             if( ! cast.isCancelled()) {
                 // Not cancellable after that !
-                def.castNotCancellable(entity);
+                def.castNotCancellable(caster);
                 // Don't decrement item.
             }
             event.setCancelled(cast.isInteractionCancelled());
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/runner/SpellRuntimeImpl.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/runner/SpellRuntimeImpl.java
@@ -1,5 +1,6 @@
 package fr.jamailun.ultimatespellsystem.plugin.runner;
 
+import fr.jamailun.ultimatespellsystem.api.entities.SpellEntity;
 import fr.jamailun.ultimatespellsystem.api.runner.SpellRuntime;
 import fr.jamailun.ultimatespellsystem.plugin.entities.BukkitSpellEntity;
 import lombok.Getter;
@@ -12,16 +13,20 @@
 @Getter
 public final class SpellRuntimeImpl extends AbstractSpellRuntime {
 
-    private final LivingEntity caster;
+    private final SpellEntity caster;
+
+    public SpellRuntimeImpl(@NotNull LivingEntity caster) {
+        this(new BukkitSpellEntity(caster));
+    }
 
     /**
      * Create a new context.
      * @param caster the caster to declare.
      */
-    public SpellRuntimeImpl(@NotNull LivingEntity caster) {
+    public SpellRuntimeImpl(@NotNull SpellEntity caster) {
         super(new ExitCode());
         this.caster = caster;
-        variables.set("caster", new BukkitSpellEntity(caster));
+        variables.set("caster", caster);
     }
 
     private SpellRuntimeImpl(@NotNull SpellRuntimeImpl parent) {
@@ -35,7 +40,7 @@ private SpellRuntimeImpl(@NotNull SpellRuntimeImpl parent) {
     }
 
     @Override
-    public @NotNull SpellRuntime makeChildNewCaster(@NotNull LivingEntity newCaster) {
+    public @NotNull SpellRuntime makeChildNewCaster(@NotNull SpellEntity newCaster) {
         return new SpellRuntimeImpl(this);
     }
 
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/runner/nodes/functions/SummonNode.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/runner/nodes/functions/SummonNode.java
@@ -26,7 +26,7 @@ public class SummonNode extends RuntimeStatement {
     public void run(@NotNull SpellRuntime runtime) {
         UssEntityType entityType = runtime.safeEvaluate(type, UssEntityType.class);
         Duration duration = runtime.safeEvaluate(this.duration, Duration.class);
-        LivingEntity caster = runtime.getCaster();
+        SpellEntity caster = runtime.getCaster();
         Location location = getSource(runtime, caster, entityType);
 
         // Summon
@@ -42,12 +42,13 @@ public void run(@NotNull SpellRuntime runtime) {
         }
     }
 
-    private @NotNull Location getSource(@NotNull SpellRuntime runtime, @NotNull Entity caster, @NotNull UssEntityType type) {
+    private @NotNull Location getSource(@NotNull SpellRuntime runtime, @NotNull SpellEntity caster, @NotNull UssEntityType type) {
         if(source == null)
             return caster.getLocation();
 
         Object sourceValue = runtime.safeEvaluate(source, Object.class);
         return switch(sourceValue) {
+            case null -> throw new InvalidTypeException("teleport.location", "the value has not been set!");
             case Location sourceLoc -> sourceLoc;
             case SpellEntity sourceEntity -> type.isProjectileLike() ? sourceEntity.getEyeLocation() : sourceEntity.getLocation();
             default -> throw new InvalidTypeException("teleport.location", "location or entity", sourceValue);
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/spells/AbstractSpell.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/spells/AbstractSpell.java
diff --git a/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/spells/SpellDefinition.java b/plugin/src/main/java/fr/jamailun/ultimatespellsystem/plugin/spells/SpellDefinition.java
