Refactor projectiles classes (#2552)

ImMorpheus · web-flow · commit b4fab131ee01 · 2024-07-06T16:27:02.000Z
* Refactor projectiles classes

* run spotlessApply

* Update EyeOfEnder.java

* Rename ArrowEntity to ArrowLike

* Drop EntityTargetingProjectile

* Add ItemSupplier and remove ThrowableProjectile

* Abstract ItemRepresentable behaviour to a separate class

* Update item frames

* Update ItemRepresentable.java

* run spotlessApply

* Rename DamagingProjectile to AcceleratingProjectile

* run spotlessApply

* Update ShulkerBullet.java

* Update EyeOfEnder.java
diff --git a/src/main/java/org/spongepowered/api/data/Keys.java b/src/main/java/org/spongepowered/api/data/Keys.java
@@ -189,15 +189,15 @@
 import org.spongepowered.api.entity.living.player.server.ServerPlayer;
 import org.spongepowered.api.entity.living.slime.Slime;
 import org.spongepowered.api.entity.living.trader.Villager;
-import org.spongepowered.api.entity.projectile.DamagingProjectile;
+import org.spongepowered.api.entity.projectile.AcceleratingProjectile;
 import org.spongepowered.api.entity.projectile.EyeOfEnder;
 import org.spongepowered.api.entity.projectile.FishingBobber;
 import org.spongepowered.api.entity.projectile.IgnitingProjectile;
 import org.spongepowered.api.entity.projectile.Potion;
 import org.spongepowered.api.entity.projectile.Projectile;
 import org.spongepowered.api.entity.projectile.ShulkerBullet;
 import org.spongepowered.api.entity.projectile.arrow.Arrow;
-import org.spongepowered.api.entity.projectile.arrow.ArrowEntity;
+import org.spongepowered.api.entity.projectile.arrow.ArrowLike;
 import org.spongepowered.api.entity.projectile.explosive.FireworkRocket;
 import org.spongepowered.api.entity.projectile.explosive.WitherSkull;
 import org.spongepowered.api.entity.vehicle.Boat;
@@ -304,7 +304,7 @@ public final class Keys {
     public static final Key<Value<Double>> ABSORPTION = Keys.key(ResourceKey.sponge("absorption"), Double.class);
 
     /**
-     * The acceleration of a {@link DamagingProjectile}.
+     * The acceleration of a {@link AcceleratingProjectile}.
      */
     public static final Key<Value<Double>> ACCELERATION = Keys.key(ResourceKey.sponge("acceleration"), Double.class);
 
@@ -413,7 +413,7 @@ public final class Keys {
     public static final Key<Value<AttachmentSurface>> ATTACHMENT_SURFACE = Keys.key(ResourceKey.sponge("attachment_surface"), AttachmentSurface.class);
 
     /**
-     * The damage dealt by an {@link ArrowEntity} on impact.
+     * The damage dealt by an {@link ArrowLike} on impact.
      */
     public static final Key<Value<Double>> ATTACK_DAMAGE = Keys.key(ResourceKey.sponge("attack_damage"), Double.class);
 
@@ -781,11 +781,11 @@ public final class Keys {
     public static final Key<Value<SpellType>> CURRENT_SPELL = Keys.key(ResourceKey.sponge("current_spell"), SpellType.class);
 
     /**
-     * The damage dealt towards entities of a specific {@link EntityType} by a {@link ArrowEntity}.
+     * The damage dealt towards entities of a specific {@link EntityType} by a {@link ArrowLike}.
      *
      * <p>Note that in events, the damage defined for the provided
      * {@link EntityType} will take priority over the "default" damage as
-     * defined from {@link ArrowEntity#attackDamage()}.</p>
+     * defined from {@link ArrowLike#attackDamage()}.</p>
      *
      * <p>Types not present in this mapping will be
      * dealt damage to according to {@link #ATTACK_DAMAGE}.</p>
@@ -2089,7 +2089,7 @@ public final class Keys {
     public static final Key<Value<ItemStackSnapshot>> ITEM_STACK_SNAPSHOT = Keys.key(ResourceKey.sponge("item_stack_snapshot"), ItemStackSnapshot.class);
 
     /**
-     * The custom knockback strength applied by an {@link ArrowEntity}.
+     * The custom knockback strength applied by an {@link ArrowLike}.
      *
      * <p>For the knockback provided by hits with a weapon according to the
      * enchantment of the same name, see {@link #APPLIED_ENCHANTMENTS}.</p>
@@ -2538,7 +2538,7 @@ public final class Keys {
     public static final Key<Value<Ticks>> PICKUP_DELAY = Keys.key(ResourceKey.sponge("pickup_delay"), Ticks.class);
 
     /**
-     * The {@link PickupRule} of an {@link ArrowEntity}.
+     * The {@link PickupRule} of an {@link ArrowLike}.
      */
     public static final Key<Value<PickupRule>> PICKUP_RULE = Keys.key(ResourceKey.sponge("pickup_rule"), PickupRule.class);
 
@@ -2605,7 +2605,7 @@ public final class Keys {
 
     /**
      * The potion effects that are present on an {@link Entity}
-     * <p>or applied by an {@link AreaEffectCloud} or {@link ArrowEntity}</p>
+     * <p>or applied by an {@link AreaEffectCloud} or {@link ArrowLike}</p>
      * <p>or stored on an {@link ItemStack}.</p>
      */
     public static final Key<ListValue<PotionEffect>> POTION_EFFECTS = Keys.listKey(ResourceKey.sponge("potion_effects"), PotionEffect.class);
diff --git a/src/main/java/org/spongepowered/api/data/type/PickupRule.java b/src/main/java/org/spongepowered/api/data/type/PickupRule.java
@@ -24,12 +24,12 @@
  */
 package org.spongepowered.api.data.type;
 
-import org.spongepowered.api.entity.projectile.arrow.ArrowEntity;
+import org.spongepowered.api.entity.projectile.arrow.ArrowLike;
 import org.spongepowered.api.registry.DefaultedRegistryValue;
 import org.spongepowered.api.util.annotation.CatalogedBy;
 
 /**
- * Represents a pickup rule used by {@link ArrowEntity}s.
+ * Represents a pickup rule used by {@link ArrowLike}s.
  */
 @CatalogedBy(PickupRules.class)
 public interface PickupRule extends DefaultedRegistryValue {
diff --git a/src/main/java/org/spongepowered/api/entity/Item.java b/src/main/java/org/spongepowered/api/entity/Item.java
@@ -26,22 +26,12 @@
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.Value;
-import org.spongepowered.api.item.inventory.ItemStackSnapshot;
 import org.spongepowered.api.util.Ticks;
 
 /**
  * Represents an Item.
  */
-public interface Item extends Entity {
-
-    /**
-     * {@link Keys#ITEM_STACK_SNAPSHOT}
-     *
-     * @return The item being represented by this entity
-     */
-    default Value.Mutable<ItemStackSnapshot> item() {
-        return this.requireValue(Keys.ITEM_STACK_SNAPSHOT).asMutable();
-    }
+public interface Item extends Entity, ItemRepresentable {
 
     /**
      * {@link Keys#DESPAWN_DELAY}
diff --git a/src/main/java/org/spongepowered/api/entity/ItemRepresentable.java b/src/main/java/org/spongepowered/api/entity/ItemRepresentable.java
@@ -22,25 +22,20 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  * THE SOFTWARE.
  */
-package org.spongepowered.api.entity.projectile;
+package org.spongepowered.api.entity;
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.Value;
-import org.spongepowered.api.entity.Entity;
+import org.spongepowered.api.item.inventory.ItemStackSnapshot;
 
-import java.util.Optional;
-
-/**
- * Represents a {@link Projectile} targeting an {@link Entity}
- */
-public interface EntityTargetingProjectile extends Projectile {
+public interface ItemRepresentable extends Entity {
 
     /**
-     * {@link Keys#TARGET_ENTITY}
+     * {@link Keys#ITEM_STACK_SNAPSHOT}
      *
-     * @return The targeted entity, if available
+     * @return The item being represented by this entity
      */
-    default Optional<Value.Mutable<Entity>> targetEntity() {
-        return this.getValue(Keys.TARGET_ENTITY).map(Value::asMutable);
+    default Value.Mutable<ItemStackSnapshot> item() {
+        return this.requireValue(Keys.ITEM_STACK_SNAPSHOT).asMutable();
     }
 }
diff --git a/src/main/java/org/spongepowered/api/entity/OminousItemSpawner.java b/src/main/java/org/spongepowered/api/entity/OminousItemSpawner.java
@@ -24,5 +24,5 @@
  */
 package org.spongepowered.api.entity;
 
-public interface OminousItemSpawner extends Entity {
+public interface OminousItemSpawner extends Entity, ItemRepresentable {
 }
diff --git a/src/main/java/org/spongepowered/api/entity/display/ItemDisplay.java b/src/main/java/org/spongepowered/api/entity/display/ItemDisplay.java
@@ -25,20 +25,12 @@
 package org.spongepowered.api.entity.display;
 
 import org.spongepowered.api.data.Keys;
-import org.spongepowered.api.item.inventory.ItemStackSnapshot;
+import org.spongepowered.api.entity.ItemRepresentable;
 
 /**
  * A ItemDisplay is an entity that displays a single item in the world.
  */
-public interface ItemDisplay extends DisplayEntity {
-    /**
-     * Returns the {@link ItemStackSnapshot item} displayed.
-     *
-     * @return The item displayed
-     */
-    default ItemStackSnapshot displayedItem() {
-        return this.require(Keys.ITEM_STACK_SNAPSHOT);
-    }
+public interface ItemDisplay extends DisplayEntity, ItemRepresentable {
 
     /**
      * Returns the {@link ItemDisplayType display type}.
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/AcceleratingProjectile.java b/src/main/java/org/spongepowered/api/entity/projectile/AcceleratingProjectile.java
@@ -28,9 +28,9 @@
 import org.spongepowered.api.data.value.Value;
 
 /**
- * Represents a {@link Projectile} that inflicts damage.
+ * Represents a {@link Projectile} that can accelerate.
  */
-public interface DamagingProjectile extends Projectile {
+public interface AcceleratingProjectile extends Projectile {
 
     /**
      * {@link Keys#ACCELERATION}
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/Egg.java b/src/main/java/org/spongepowered/api/entity/projectile/Egg.java
@@ -27,6 +27,6 @@
 /**
  * Represents a thrown egg.
  */
-public interface Egg extends DamagingProjectile {
+public interface Egg extends ThrowableItemProjectile {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/EnderPearl.java b/src/main/java/org/spongepowered/api/entity/projectile/EnderPearl.java
@@ -27,6 +27,6 @@
 /**
  * Represents an Ender Pearl.
  */
-public interface EnderPearl extends DamagingProjectile {
+public interface EnderPearl extends ThrowableItemProjectile {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/EvokerFangs.java b/src/main/java/org/spongepowered/api/entity/projectile/EvokerFangs.java
@@ -24,5 +24,7 @@
  */
 package org.spongepowered.api.entity.projectile;
 
-public interface EvokerFangs extends Projectile {
+import org.spongepowered.api.entity.Entity;
+
+public interface EvokerFangs extends Entity {
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/ExperienceBottle.java b/src/main/java/org/spongepowered/api/entity/projectile/ExperienceBottle.java
@@ -27,6 +27,6 @@
 /**
  * Represents a thrown experience bottle.
  */
-public interface ExperienceBottle extends Projectile {
+public interface ExperienceBottle extends ThrowableItemProjectile {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/EyeOfEnder.java b/src/main/java/org/spongepowered/api/entity/projectile/EyeOfEnder.java
@@ -26,13 +26,14 @@
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.Value;
+import org.spongepowered.api.entity.ItemRepresentable;
 import org.spongepowered.api.util.Ticks;
 import org.spongepowered.math.vector.Vector3d;
 
 /**
  * Represents an Eye of Ender.
  */
-public interface EyeOfEnder extends Projectile {
+public interface EyeOfEnder extends Projectile, ItemRepresentable {
 
     /**
      * {@link Keys#DESPAWN_DELAY}
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/IgnitingProjectile.java b/src/main/java/org/spongepowered/api/entity/projectile/IgnitingProjectile.java
@@ -24,11 +24,12 @@
  */
 package org.spongepowered.api.entity.projectile;
 
+import org.spongepowered.api.entity.ItemRepresentable;
 import org.spongepowered.api.entity.projectile.explosive.fireball.SmallFireball;
 
 /**
  * Represents an abstract projectile that may ignite, such as {@link SmallFireball}.
  */
-public interface IgnitingProjectile extends DamagingProjectile {
+public interface IgnitingProjectile extends AcceleratingProjectile, ItemRepresentable {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/Potion.java b/src/main/java/org/spongepowered/api/entity/projectile/Potion.java
@@ -26,23 +26,12 @@
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.ListValue;
-import org.spongepowered.api.data.value.Value;
 import org.spongepowered.api.effect.potion.PotionEffect;
-import org.spongepowered.api.item.inventory.ItemStackSnapshot;
 
 /**
  * Represents a thrown potion.
  */
-public interface Potion extends Projectile {
-
-    /**
-     * {@link Keys#ITEM_STACK_SNAPSHOT}
-     *
-     * @return The potion item represented by this potion
-     */
-    default Value.Mutable<ItemStackSnapshot> item() {
-        return this.requireValue(Keys.ITEM_STACK_SNAPSHOT).asMutable();
-    }
+public interface Potion extends ThrowableItemProjectile {
 
     /**
      * {@link Keys#POTION_EFFECTS}
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/Projectile.java b/src/main/java/org/spongepowered/api/entity/projectile/Projectile.java
@@ -32,8 +32,7 @@
 import java.util.Optional;
 
 /**
- * Represents entities that act as projectiles and can fly in the air.
- * For example, Arrows.
+ * Represents an abstract projectile.
  */
 public interface Projectile extends Entity {
 
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/ShulkerBullet.java b/src/main/java/org/spongepowered/api/entity/projectile/ShulkerBullet.java
@@ -26,20 +26,32 @@
 
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.data.value.Value;
+import org.spongepowered.api.entity.Entity;
 import org.spongepowered.api.entity.living.golem.Shulker;
 import org.spongepowered.api.util.Direction;
 
+import java.util.Optional;
+
 /**
  * A {@link ShulkerBullet} is the projectile {@link Shulker}s shoot.
  */
-public interface ShulkerBullet extends EntityTargetingProjectile, DamagingProjectile {
+public interface ShulkerBullet extends Projectile {
 
     /**
      * {@link Keys#DIRECTION}
      *
      * @return The direction of this bullet
      */
-    default Value.Mutable<Direction> hangingDirection() {
+    default Value.Mutable<Direction> flyingDirection() {
         return this.requireValue(Keys.DIRECTION).asMutable();
     }
+
+    /**
+     * {@link Keys#TARGET_ENTITY}
+     *
+     * @return The targeted entity, if available
+     */
+    default Optional<Value.Mutable<Entity>> targetEntity() {
+        return this.getValue(Keys.TARGET_ENTITY).map(Value::asMutable);
+    }
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/Snowball.java b/src/main/java/org/spongepowered/api/entity/projectile/Snowball.java
@@ -27,6 +27,6 @@
 /**
  * Represents a Snowball.
  */
-public interface Snowball extends DamagingProjectile {
+public interface Snowball extends ThrowableItemProjectile {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/ThrowableItemProjectile.java b/src/main/java/org/spongepowered/api/entity/projectile/ThrowableItemProjectile.java
@@ -0,0 +1,30 @@
+/*
+ * This file is part of SpongeAPI, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package org.spongepowered.api.entity.projectile;
+
+import org.spongepowered.api.entity.ItemRepresentable;
+
+public interface ThrowableItemProjectile extends Projectile, ItemRepresentable {
+}
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/arrow/Arrow.java b/src/main/java/org/spongepowered/api/entity/projectile/arrow/Arrow.java
@@ -31,7 +31,7 @@
 /**
  * An arrow generally "tipped" with one or more potion effects.
  */
-public interface Arrow extends ArrowEntity {
+public interface Arrow extends ArrowLike {
 
     /**
      * {@link Keys#POTION_EFFECTS}
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/arrow/ArrowLike.java b/src/main/java/org/spongepowered/api/entity/projectile/arrow/ArrowLike.java
@@ -29,12 +29,12 @@
 import org.spongepowered.api.data.value.MapValue;
 import org.spongepowered.api.data.value.Value;
 import org.spongepowered.api.entity.EntityType;
-import org.spongepowered.api.entity.projectile.DamagingProjectile;
+import org.spongepowered.api.entity.projectile.Projectile;
 
 /**
- * Represents an Arrow.
+ * An abstract representation of an Arrow.
  */
-public interface ArrowEntity extends DamagingProjectile {
+public interface ArrowLike extends Projectile {
 
     /**
      * {@link Keys#PICKUP_RULE}
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/arrow/SpectralArrow.java b/src/main/java/org/spongepowered/api/entity/projectile/arrow/SpectralArrow.java
@@ -27,9 +27,9 @@
 import org.spongepowered.api.effect.potion.PotionEffectTypes;
 
 /**
- * An {@link ArrowEntity} which applies the {@link PotionEffectTypes#GLOWING}
+ * An {@link ArrowLike} which applies the {@link PotionEffectTypes#GLOWING}
  * effect on hit.
  */
-public interface SpectralArrow extends ArrowEntity {
+public interface SpectralArrow extends ArrowLike {
 
 }
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/arrow/Trident.java b/src/main/java/org/spongepowered/api/entity/projectile/arrow/Trident.java
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/explosive/FireworkRocket.java b/src/main/java/org/spongepowered/api/entity/projectile/explosive/FireworkRocket.java
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/explosive/WitherSkull.java b/src/main/java/org/spongepowered/api/entity/projectile/explosive/WitherSkull.java
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/explosive/fireball/DragonFireball.java b/src/main/java/org/spongepowered/api/entity/projectile/explosive/fireball/DragonFireball.java
diff --git a/src/main/java/org/spongepowered/api/entity/projectile/windcharge/WindChargeLike.java b/src/main/java/org/spongepowered/api/entity/projectile/windcharge/WindChargeLike.java
diff --git a/src/main/java/org/spongepowered/api/event/entity/AttackEntityEvent.java b/src/main/java/org/spongepowered/api/event/entity/AttackEntityEvent.java
diff --git a/src/main/java/org/spongepowered/api/event/entity/DamageEntityEvent.java b/src/main/java/org/spongepowered/api/event/entity/DamageEntityEvent.java

Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,5 @@`
`24`	`24`	`*/`
`25`	`25`	`package org.spongepowered.api.entity;`
`26`	`26`
`27`		`-public interface OminousItemSpawner extends Entity {`
	`27`	`+public interface OminousItemSpawner extends Entity, ItemRepresentable {`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,6 @@`
`27`	`27`	`/**`
`28`	`28`	`* Represents a thrown egg.`
`29`	`29`	`*/`
`30`		`-public interface Egg extends DamagingProjectile {`
	`30`	`+public interface Egg extends ThrowableItemProjectile {`
`31`	`31`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,7 @@`
`24`	`24`	`*/`
`25`	`25`	`package org.spongepowered.api.entity.projectile;`
`26`	`26`
`27`		`-public interface EvokerFangs extends Projectile {`
	`27`	`+import org.spongepowered.api.entity.Entity;`
	`28`	`+`
	`29`	`+public interface EvokerFangs extends Entity {`
`28`	`30`	`}`