Raid max Groups configurable by API (#12896)

Co-authored-by: Bjarne Koll <[email protected]>
Co-authored-by: Owen1212055 <[email protected]>

Author: 3 people

build-data/paper.at

@@ -486,7 +486,6 @@ public net.minecraft.world.entity.projectile.hurtingprojectile.windcharge.Breeze
 public net.minecraft.world.entity.projectile.hurtingprojectile.windcharge.WindCharge explode(Lnet/minecraft/world/phys/Vec3;)V
 public net.minecraft.world.entity.projectile.throwableitemprojectile.ThrowableItemProjectile getDefaultItem()Lnet/minecraft/world/item/Item;
 public net.minecraft.world.entity.raid.Raid heroesOfTheVillage
-public net.minecraft.world.entity.raid.Raid numGroups
 public net.minecraft.world.entity.raid.Raid raidEvent
 public net.minecraft.world.entity.raid.Raid raidOmenLevel
 public net.minecraft.world.entity.raid.Raid ticksActive
@@ -765,6 +764,7 @@ public-f net.minecraft.world.entity.Mob goalSelector
 public-f net.minecraft.world.entity.Mob targetSelector
 public-f net.minecraft.world.entity.ai.attributes.RangedAttribute maxValue
 public-f net.minecraft.world.entity.player.Player gameProfile
+public-f net.minecraft.world.entity.raid.Raid numGroups
 public-f net.minecraft.world.inventory.AbstractContainerMenu dataSlots
 public-f net.minecraft.world.inventory.AbstractContainerMenu lastSlots
 public-f net.minecraft.world.inventory.AbstractContainerMenu remoteDataSlots

paper-api/src/main/java/org/bukkit/Raid.java

@@ -3,13 +3,16 @@
 import java.util.List;
 import java.util.Set;
 import java.util.UUID;
+import org.bukkit.boss.BossBar;
 import org.bukkit.entity.Raider;
-import org.jetbrains.annotations.NotNull;
+import org.bukkit.persistence.PersistentDataHolder;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * Represents a raid event.
  */
-public interface Raid extends org.bukkit.persistence.PersistentDataHolder { // Paper
+@NullMarked
+public interface Raid extends PersistentDataHolder {
 
     /**
      * Get whether this raid started.
@@ -48,7 +51,6 @@ public interface Raid extends org.bukkit.persistence.PersistentDataHolder { // P
      *
      * @return location
      */
-    @NotNull
     Location getLocation();
 
     /**
@@ -59,7 +61,6 @@ public interface Raid extends org.bukkit.persistence.PersistentDataHolder { // P
      *
      * @return Raids status
      */
-    @NotNull
     RaidStatus getStatus();
 
     /**
@@ -86,6 +87,16 @@ public interface Raid extends org.bukkit.persistence.PersistentDataHolder { // P
      */
     int getTotalWaves();
 
+    /**
+     * Sets the number of waves in this raid.
+     *
+     * @param totalWaves number of waves
+     * @throws IllegalArgumentException if totalWaves is negative or zero
+     * @throws IllegalArgumentException if totalWaves is larger than 7, which is the most waves a vanilla raid can have.
+     * @throws IllegalArgumentException if the totalWaves is less than {@link #getSpawnedGroups()}
+     */
+    void setTotalWaves(int totalWaves);
+
     /**
      * Gets the sum of all raider's health.
      *
@@ -98,21 +109,36 @@ public interface Raid extends org.bukkit.persistence.PersistentDataHolder { // P
      *
      * @return a set of unique ids
      */
-    @NotNull
     Set<UUID> getHeroes();
 
     /**
      * Gets all remaining {@link Raider} in the present wave.
      *
      * @return a list of current raiders
      */
-    @NotNull
     List<Raider> getRaiders();
 
+    /**
+     * Gets the id of this raid.
+     *
+     * @return the raid id
+     * @deprecated Raid identifiers are magic internal values and may or may not be present.
+     * -1 is returned for raids without an assigned id.
+     */
+    @Deprecated(forRemoval = true, since = "1.21.5")
+    int getId();
+
+    /**
+     * Get the boss bar to be displayed for this raid.
+     *
+     * @return the boss bar
+     */
+    BossBar getBossBar();
+
     /**
      * Represents the status of a {@link Raid}.
      */
-    public enum RaidStatus {
+    enum RaidStatus {
 
         /**
          * The raid is in progress.
@@ -131,23 +157,4 @@ public enum RaidStatus {
          */
         STOPPED;
     }
-
-    // Paper start
-    /**
-     * Gets the id of this raid.
-     *
-     * @return the raid id
-     * @deprecated Raid identifiers are magic internal values and may or may not be present.
-     * -1 is returned for raids without an assigned id.
-     */
-    @Deprecated(forRemoval = true, since = "1.21.5")
-    int getId();
-
-    /**
-     * Get the boss bar to be displayed for this raid.
-     *
-     * @return the boss bar
-     */
-    org.bukkit.boss.@NotNull BossBar getBossBar();
-    // Paper end
 }

paper-server/src/main/java/org/bukkit/craftbukkit/CraftRaid.java

@@ -6,13 +6,15 @@
 import java.util.List;
 import java.util.Set;
 import java.util.UUID;
-import java.util.function.Function;
 import net.minecraft.core.BlockPos;
 import net.minecraft.world.level.Level;
 import org.bukkit.Location;
 import org.bukkit.Raid;
+import org.bukkit.boss.BossBar;
+import org.bukkit.craftbukkit.boss.CraftBossBar;
 import org.bukkit.craftbukkit.util.CraftLocation;
 import org.bukkit.entity.Raider;
+import org.bukkit.persistence.PersistentDataContainer;
 
 public final class CraftRaid implements Raid {
 
@@ -80,6 +82,14 @@ public int getTotalWaves() {
         return this.handle.numGroups;
     }
 
+    @Override
+    public void setTotalWaves(int waves) {
+        Preconditions.checkArgument(waves > 0, "Total waves must be greater than 0");
+        Preconditions.checkArgument(waves <= 7, "Total waves must not be greater than 7");
+        Preconditions.checkArgument(waves >= this.getSpawnedGroups(), "Total waves must be greater than or equal to the current spawned groups (%s)", this.getSpawnedGroups());
+        this.handle.numGroups = waves;
+    }
+
     @Override
     public float getTotalHealth() {
         return this.handle.getHealthOfLivingRaiders();
@@ -92,12 +102,7 @@ public Set<UUID> getHeroes() {
 
     @Override
     public List<Raider> getRaiders() {
-        return this.handle.getRaiders().stream().map(new Function<net.minecraft.world.entity.raid.Raider, Raider>() {
-            @Override
-            public Raider apply(net.minecraft.world.entity.raid.Raider entityRaider) {
-                return (Raider) entityRaider.getBukkitEntity();
-            }
-        }).collect(ImmutableList.toImmutableList());
+        return this.handle.getRaiders().stream().map(entityRaider -> (Raider) entityRaider.getBukkitEntity()).collect(ImmutableList.toImmutableList());
     }
 
     public net.minecraft.world.entity.raid.Raid getHandle() {
@@ -110,20 +115,20 @@ public int getId() {
     }
 
     @Override
-    public org.bukkit.boss.BossBar getBossBar() {
-        return new org.bukkit.craftbukkit.boss.CraftBossBar(this.handle.raidEvent);
+    public BossBar getBossBar() {
+        return new CraftBossBar(this.handle.raidEvent);
     }
 
     @Override
-    public org.bukkit.persistence.PersistentDataContainer getPersistentDataContainer() {
+    public PersistentDataContainer getPersistentDataContainer() {
         return this.handle.persistentDataContainer;
     }
 
     @Override
     public boolean equals(final Object o) {
         if (this == o) return true;
         if (o == null || this.getClass() != o.getClass()) return false;
-        final org.bukkit.craftbukkit.CraftRaid craftRaid = (org.bukkit.craftbukkit.CraftRaid) o;
+        final CraftRaid craftRaid = (CraftRaid) o;
         return this.handle.equals(craftRaid.handle);
     }