Make exhaustion nullable in PaperDamageTypeRegistryEntry and damageEffects and deathMessageType no longer nullable

Author: Chaosdave34

paper-api/src/main/java/io/papermc/paper/registry/data/DamageTypeRegistryEntry.java

@@ -7,7 +7,6 @@
 import org.bukkit.damage.DeathMessageType;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Contract;
-import org.jspecify.annotations.Nullable;
 
 /**
  * A data-centric version-specific registry entry for the {@link DamageType} type.
@@ -45,15 +44,25 @@ public interface DamageTypeRegistryEntry {
      *
      * @return the damage effect
      */
-    @Nullable DamageEffect damageEffect();
+    DamageEffect damageEffect();
 
     /**
      * Provides the {@link DeathMessageType} for this damage type.
      *
      * @return the death message type
      */
-    @Nullable DeathMessageType deathMessageType();
+    DeathMessageType deathMessageType();
 
+    /**
+     * A mutable builder for the {@link DamageTypeRegistryEntry} plugins may change in applicable registry events.
+     * <p>
+     * The following values are required for each builder:
+     * <ul>
+     *     <li>{@link #messageId(String)}</li>
+     *     <li>{@link #exhaustion(float)}</li>
+     *     <li>{@link #damageScaling(DamageScaling)}</li>
+     * </ul>
+     */
     @ApiStatus.Experimental
     @ApiStatus.NonExtendable
     interface Builder extends DamageTypeRegistryEntry, RegistryBuilder<DamageType> {
@@ -95,7 +104,7 @@ interface Builder extends DamageTypeRegistryEntry, RegistryBuilder<DamageType> {
          * @see DamageType#getDamageEffect()
          */
         @Contract(value = "_ -> this", mutates = "this")
-        Builder damageEffect(@Nullable DamageEffect effect);
+        Builder damageEffect(DamageEffect effect);
 
         /**
          * Sets the {@link DeathMessageType} for this damage type.
@@ -105,6 +114,6 @@ interface Builder extends DamageTypeRegistryEntry, RegistryBuilder<DamageType> {
          * @see DamageType#getDeathMessageType()
          */
         @Contract(value = "_ -> this", mutates = "this")
-        Builder deathMessageType(@Nullable DeathMessageType deathMessageType);
+        Builder deathMessageType(DeathMessageType deathMessageType);
     }
 }

paper-server/src/main/java/io/papermc/paper/registry/data/PaperDamageTypeRegistryEntry.java

@@ -12,10 +12,10 @@
 
 public class PaperDamageTypeRegistryEntry implements DamageTypeRegistryEntry {
     protected @Nullable String messageId;
-    protected float exhaustion;
+    protected @Nullable Float exhaustion;
     protected @Nullable DamageScaling damageScaling;
-    protected @Nullable DamageEffects damageEffects;
-    protected @Nullable DeathMessageType deathMessageType;
+    protected DamageEffects damageEffects;
+    protected DeathMessageType deathMessageType;
 
     protected final Conversions conversions;
 
@@ -24,7 +24,11 @@ public PaperDamageTypeRegistryEntry(
             final @Nullable DamageType internal
     ) {
         this.conversions = conversions;
-        if (internal == null) return;
+        if (internal == null) {
+            this.damageEffects = DamageEffects.HURT;
+            this.deathMessageType = DeathMessageType.DEFAULT;
+            return;
+        }
 
         this.messageId = internal.msgId();
         this.exhaustion = internal.exhaustion();
@@ -40,7 +44,7 @@ public String messageId() {
 
     @Override
     public float exhaustion() {
-        return exhaustion;
+        return asConfigured(exhaustion, "exhaustion");
     }
 
     @Override
@@ -49,13 +53,13 @@ public org.bukkit.damage.DamageScaling damageScaling() {
     }
 
     @Override
-    public @Nullable DamageEffect damageEffect() {
-        return damageEffects == null ? null : CraftDamageEffect.toBukkit(damageEffects);
+    public DamageEffect damageEffect() {
+        return CraftDamageEffect.toBukkit(damageEffects);
     }
 
     @Override
-    public org.bukkit.damage.@Nullable DeathMessageType deathMessageType() {
-        return deathMessageType == null ? null : CraftDamageType.deathMessageTypeToBukkit(deathMessageType);
+    public org.bukkit.damage.DeathMessageType deathMessageType() {
+        return CraftDamageType.deathMessageTypeToBukkit(deathMessageType);
     }
 
     public static final class PaperBuilder extends PaperDamageTypeRegistryEntry implements DamageTypeRegistryEntry.Builder, PaperRegistryBuilder<DamageType, org.bukkit.damage.DamageType> {
@@ -83,39 +87,25 @@ public Builder damageScaling(org.bukkit.damage.DamageScaling scaling) {
         }
 
         @Override
-        public Builder damageEffect(@Nullable DamageEffect effect) {
-            this.damageEffects = effect == null ? null : ((CraftDamageEffect) effect).getHandle();
+        public Builder damageEffect(DamageEffect effect) {
+            this.damageEffects = ((CraftDamageEffect) effect).getHandle();
             return this;
         }
 
         @Override
-        public Builder deathMessageType(org.bukkit.damage.@Nullable DeathMessageType deathMessageType) {
-            this.deathMessageType = deathMessageType == null ? null : CraftDamageType.deathMessageTypeToNMS(deathMessageType);
+        public Builder deathMessageType(org.bukkit.damage.DeathMessageType deathMessageType) {
+            this.deathMessageType = CraftDamageType.deathMessageTypeToNMS(deathMessageType);
             return this;
         }
 
         @Override
         public DamageType build() {
-            if (this.damageEffects != null && this.deathMessageType != null) {
-                return new DamageType(
-                        asConfigured(this.messageId, "messsageId"),
-                        asConfigured(this.damageScaling, "scaling"),
-                        this.exhaustion,
-                        this.damageEffects,
-                        this.deathMessageType);
-            } else if (this.damageEffects != null) {
-                return new DamageType(
-                        asConfigured(this.messageId, "messsageId"),
-                        asConfigured(this.damageScaling, "scaling"),
-                        this.exhaustion,
-                        this.damageEffects);
-            } else {
-                return new DamageType(
-                        asConfigured(this.messageId, "messsageId"),
-                        asConfigured(this.damageScaling, "scaling"),
-                        this.exhaustion
-                );
-            }
+            return new DamageType(
+                    asConfigured(this.messageId, "messsageId"),
+                    asConfigured(this.damageScaling, "scaling"),
+                    asConfigured(this.exhaustion, "exhaustion"),
+                    this.damageEffects,
+                    this.deathMessageType);
         }
     }
 }