Update 20250319 - Refactorization and Update

Updated the target version to the latest one while also refactoring some base classes.

[CHANGELOG]
🟢 Added some more documentations.
🟢 Added some default interface implementations to some base classes.
🟢 Added two new abstract methods for the `TurretProjectileEntity` super class, allowing more control over armor affected attributes.
🟢 Added a new Enum, which purpose is to define an entity's armor type based on its armor point.
🟡 Updated the dependencies' versions in the gradle properties.
🟡 Renamed `BulletEntity` to `MGBulletEntity`.
🟡 Moved the code that modifies the piercing, damage, and velocity of a projectile based on armor from the base class `KineticProjectileEntity` to its parent base class `TurretProjectileEntity`.
🟡 Changed parameter names of `MGBulletEntity(World, LivingEntity)` constructor to match their uses.
🟡 Updated the `MGBulletEntity` class's max pierce level from 0 to 5.
🔴 Removed unused imports.

Author: Virus5600

gradle.properties

@@ -4,15 +4,15 @@ org.gradle.parallel=true
 
 # Fabric Properties
 # check these on https://fabricmc.net/develop
-minecraft_version=1.21.3
-yarn_mappings=1.21.3+build.2
-loader_version=0.16.9
+minecraft_version=1.21.4
+yarn_mappings=1.21.4+build.8
+loader_version=0.16.10
 
 # Mod Properties
 mod_version = 1.0.1-beta-1.21
 maven_group = com.virus5600
 archives_base_name = defensive-measures
 
 # Dependencies
-fabric_version=0.110.0+1.21.3
-geckolib_version=4.7.1
+fabric_version=0.119.0+1.21.4
+geckolib_version=4.8.4

src/main/java/com/virus5600/defensive_measures/entity/ModEntities.java

@@ -62,10 +62,10 @@ public class ModEntities {
 			.trackingTickInterval(10)
 	);
 
-	public static final EntityType<BulletEntity> MG_BULLET = RegistryUtil.registerEntity(
+	public static final EntityType<MGBulletEntity> MG_BULLET = RegistryUtil.registerEntity(
 		"mg_bullet",
 		Builder
-			.<BulletEntity>create(BulletEntity::new, SpawnGroup.MISC)
+			.<MGBulletEntity>create(MGBulletEntity::new, SpawnGroup.MISC)
 			.dropsNothing()
 			.dimensions(0.125f, 0.125f)
 			.maxTrackingRange(4)

src/main/java/com/virus5600/defensive_measures/entity/projectiles/BallistaArrowEntity.java

@@ -15,6 +15,22 @@
 
 import java.util.Map;
 
+/**
+ * BallistaArrowEntity
+ *
+ * <p>Represents a ballista arrow projectile entity that pierces through multiple entities.</p>
+ * <p>
+ *     The ballista arrow is a {@link KineticProjectileEntity kinetic projectile}
+ *     that is fired from a {@link com.virus5600.defensive_measures.entity.turrets.BallistaTurretEntity ballista turret}.
+ * </p>
+ * <p>
+ *     This projectile can pierce through multiple entities, dealing 4 hearts of damage to each
+ *     entity it hits. The arrow can pierce through a maximum of 5 entities before it is destroyed.
+ *     And everytime it pierces through an entity, it will reduce its pierce level its speed
+ *     depending on the armor of the entity it hit.
+ * </p>
+ * To see how the reduction mechanics work, check {@link KineticProjectileEntity}.
+ */
 public class BallistaArrowEntity extends KineticProjectileEntity {
 	private static final Map<String, RawAnimation> ANIMATIONS;
 

src/main/java/com/virus5600/defensive_measures/entity/projectiles/CannonballEntity.java

@@ -203,9 +203,9 @@ public void tick() {
 		super.tick();
 	}
 
-	/////////////////////////////////
-	/// INTERFACE IMPLEMENTATIONS ///
-	/////////////////////////////////
+	// ///////////////////////// //
+	// INTERFACE IMPLEMENTATIONS //
+	// ///////////////////////// //
 
 	// GeoEntity //
 	@Override

src/main/java/com/virus5600/defensive_measures/entity/projectiles/ExplosiveProjectileEntity.java

@@ -28,6 +28,20 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * {@code ExplosiveProjectileEntity} is an abstract class that extends {@link TurretProjectileEntity}.
+ * This class is used to represent a projectile entity that explodes on impact, dealing damage to
+ * entities within a certain radius. This class is used to represent explosive projectiles, such as
+ * cannonballs, missiles, and other similar projectiles.
+ * <br><br>
+ * By default, the explosive projectile entity has the following behavior:
+ * <ul>
+ *     <li>Armor points affect the piercing of the projectile.</li>
+ *     <li>Armor points do not affect the speed of the projectile.</li>
+ *     <li>Armor points do not affect the base damage dealt by the projectile.</li>
+ *     <li>Base damage is set to 5.</li>
+ * </ul>
+ */
 public abstract class ExplosiveProjectileEntity extends TurretProjectileEntity {
 	protected ParticleEffect particleTrail;
 	public double accelerationPower = 0.1;
@@ -442,4 +456,24 @@ public void onSpawnPacket(EntitySpawnS2CPacket packet) {
 		Vec3d vec3d = new Vec3d(packet.getVelocityX(), packet.getVelocityY(), packet.getVelocityZ());
 		this.setVelocity(vec3d);
 	}
+
+	// //////////////////////// //
+	// INTERFACE IMPLEMENTATION //
+	// //////////////////////// //
+
+	// PUBLIC
+	@Override
+	public boolean armorAffectsPiercing() {
+		return true;
+	}
+
+	@Override
+	public boolean armorAffectsVelocity() {
+		return false;
+	}
+
+	@Override
+	public boolean armorAffectsDamage() {
+		return false;
+	}
 }

src/main/java/com/virus5600/defensive_measures/entity/projectiles/KineticProjectileEntity.java

@@ -1,12 +1,22 @@
 package com.virus5600.defensive_measures.entity.projectiles;
 
-import net.minecraft.entity.Entity;
-import net.minecraft.entity.LivingEntity;
 import net.minecraft.entity.data.DataTracker.Builder;
 import net.minecraft.entity.EntityType;
-import net.minecraft.util.hit.EntityHitResult;
 import net.minecraft.world.World;
 
+/**
+ * {@code KineticProjectileEntity} is an abstract class that extends {@link TurretProjectileEntity}.
+ * This class is used to represent a projectile entity that uses kinetic energy to deal damage
+ * to entities, such as arrows, bullets, and other similar projectiles.
+ * <br><br>
+ * By default, the kinetic projectile entity has the following behavior:
+ * <ul>
+ *     <li>Armor points affect the piercing of the projectile.</li>
+ *     <li>Armor points affect the speed of the projectile.</li>
+ *     <li>Armor points affect the base damage dealt by the projectile.</li>
+ *     <li>Base damage is set to 4.</li>
+ * </ul>
+ */
 public abstract class KineticProjectileEntity extends TurretProjectileEntity {
 
 	// ///////////// //
@@ -28,118 +38,23 @@ protected void initDataTracker(Builder builder) {
 		super.initDataTracker(builder);
 	}
 
-	/**
-	 * {@inheritDoc}
-	 * <hr>
-	 * <h2>{@link KineticProjectileEntity}</h2>
-	 * <br><br>
-	 * The method in {@code KineticProjectileEntity} reduces the speed of the arrow
-	 * along with the pierce level based on the amount of armor points the entity has.
-	 * <br><br>
-	 * In this implementation, the projectile will have the following behavior
-	 * (assuming the projectile is affected by armor points):
-	 * <table>
-	 * 	<tr>
-	 * 		<th>Armor Points</th>
-	 * 		<th>Pierce Level Reduction</th>
-	 * 		<th>Velocity Reduction</th>
-	 * 		<th>Base Damage Reduction</th>
-	 * 	</tr>
-	 * 	<tr>
-	 * 		<td>Heavy Armor</td>
-	 * 		<td>2</td>
-	 * 		<td>50%</td>
-	 * 		<td>50%</td>
-	 * 	</tr>
-	 * 	<tr>
-	 * 		<td>Light Armor</td>
-	 * 		<td>1</td>
-	 * 		<td>25%</td>
-	 * 		<td>20%</td>
-	 * 	</tr>
-	 * 	<tr>
-	 * 		<td>No Armor</td>
-	 * 		<td>N/A</td>
-	 * 		<td>12.5%</td>
-	 * 		<td>5%</td>
-	 * 	</tr>
-	 * </table>
-	 *
-	 * @param entityHitResult {@inheritDoc EntityHitResult}
-	 */
-	@Override
-	protected void onEntityHit(EntityHitResult entityHitResult) {
-		super.onEntityHit(entityHitResult);
-
-		if (this.armorAffectsPiercing()) {
-			// Reduces the speed of the arrow when it hits an entity
-			Entity entity = entityHitResult.getEntity();
-			// For reference, max armor points is 30
-			int armor = entity instanceof LivingEntity livingEntity ? livingEntity.getArmor() : 0;
-			double dmgReduction = 0.05;
-			boolean hasHeavyArmor = armor > 15,
-				hasLightArmor = armor <= 15 && armor > 0;
-
-			if (entity instanceof LivingEntity livingEntity) {
-				double targetH = livingEntity.getHeight(),
-					arrowH = this.getHeight(),
-					variance = arrowH * 0.125; // 12.5% of the arrow's height
-
-				double arrowMin = arrowH - variance,
-					arrowMax = arrowH + variance,
-					reducedVelocity = 0.125;
-
-				// Reduce velocity and pierce level based on the side of the entity hit
-				if (this.getPierceLevel() > 0) {
-					// If the arrow is smaller than the target or has heavy armor, reduce the pierce level by 2, velocity by 50%, and base damage by 50%
-					if (targetH > arrowMax || hasHeavyArmor) {
-						this.setPierceLevel((byte) (this.getPierceLevel() - 2));
-						reducedVelocity = 0.5;
-						dmgReduction = 0.5;
-					}
-					// If the arrow is almost the same size as the target or has a light armor, reduce the pierce level by 1, velocity by 25%, and base damage by 20%
-					else if ((targetH < arrowMax && arrowMin < targetH) || hasLightArmor) {
-						this.setPierceLevel((byte) (this.getPierceLevel() - 1));
-						reducedVelocity = 0.25;
-						dmgReduction = 0.2;
-					}
-					// Otherwise, just reduce the velocity by 12.5% and base damage by 5% without reducing the pierce level
-				}
+	// ///////////////////////// //
+	// INTERFACE IMPLEMENTATIONS //
+	// ///////////////////////// //
 
-				// Apply reduced velocity
-				this.addVelocity(
-					this.getVelocity()
-						.multiply(reducedVelocity)
-						.negate()
-				);
-
-				// Apply reduced damage
-				this.setDamage(this.getDamage() * (1 - dmgReduction));
-			}
-
-			this.addVelocity(
-				this.getVelocity()
-					.negate()
-					.multiply(0.1)
-			);
-		}
+	// PUBLIC
+	@Override
+	public boolean armorAffectsPiercing() {
+		return true;
 	}
 
-	// /////////////////////////////// //
-	// GETTERS, SETTERS, AND QUESTIONS //
-	// /////////////////////////////// //
+	@Override
+	public boolean armorAffectsVelocity() {
+		return true;
+	}
 
-	// PUBLIC
-	/**
-	 * An overridable method that determines whether an armor point affects the
-	 * piercing of the projectile.
-	 * <br><br>
-	 * By default, this method returns {@code true}.
-	 *
-	 * @return {@code true} if the armor point affects the piercing of the projectile,
-	 * {@code false} otherwise.
-	 */
-	public boolean armorAffectsPiercing() {
+	@Override
+	public boolean armorAffectsDamage() {
 		return true;
 	}
 }

src/main/java/com/virus5600/defensive_measures/entity/projectiles/BulletEntity.java renamed to src/main/java/com/virus5600/defensive_measures/entity/projectiles/MGBulletEntity.java

@@ -2,7 +2,6 @@
 
 import net.minecraft.entity.EntityType;
 import net.minecraft.entity.LivingEntity;
-import net.minecraft.entity.data.DataTracker;
 import net.minecraft.entity.data.DataTracker.Builder;
 import net.minecraft.item.ItemStack;
 import net.minecraft.world.World;
@@ -13,33 +12,33 @@
 
 import com.virus5600.defensive_measures.entity.ModEntities;
 
-public class BulletEntity extends TurretProjectileEntity {
+public class MGBulletEntity extends TurretProjectileEntity {
 	private final AnimatableInstanceCache geoCache = GeckoLibUtil.createInstanceCache(this);
 
 	////////////////////
 	/// CONSTRUCTORS ///
 	////////////////////
-	public BulletEntity(
+	public MGBulletEntity(
 		EntityType<? extends TurretProjectileEntity> entityType,
 		World world
 	) {
 		super(entityType, world);
 	}
 
-	public BulletEntity(World world, LivingEntity owner) {
+	public MGBulletEntity(World world, LivingEntity owner) {
 		this(ModEntities.MG_BULLET, world);
 		this.setOwner(owner);
 	}
 
-	public BulletEntity(
+	public MGBulletEntity(
 		LivingEntity owner,
-		double directionX,
-		double directionY,
-		double directionZ,
+		double velocityX,
+		double velocityY,
+		double velocityZ,
 		World world
 	) {
 		this(world, owner);
-		this.setVelocity(directionX, directionY, directionZ);
+		this.setVelocity(velocityX, velocityY, velocityZ);
 	}
 
 	///////////////
@@ -57,7 +56,7 @@ protected final void setPierceLevel(byte pierceLevel) {
 	}
 
 	public byte getMaxPierceLevel() {
-		return 0;
+		return 5;
 	}
 
 	@Override