SPIGOT-5211: Add Raid API

By: anhcraft <admin@anhcraft.dev>
2025-08-15 20:23:53 -07:00 · 2019-08-12 18:09:35 +07:00
parent 2ef8482885
commit 71802c602b
7 changed files with 409 additions and 0 deletions
--- a/paper-api/src/main/java/org/bukkit/Raid.java
+++ b/paper-api/src/main/java/org/bukkit/Raid.java
@@ -0,0 +1,134 @@
+package org.bukkit;
+
+import java.util.List;
+import java.util.Set;
+import java.util.UUID;
+import org.bukkit.entity.Raider;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Represents a raid event.
+ */
+public interface Raid {
+
+    /**
+     * Get whether this raid started.
+     *
+     * @return whether raid is started
+     */
+    boolean isStarted();
+
+    /**
+     * Gets the amount of ticks this raid has existed.
+     *
+     * @return active ticks
+     */
+    long getActiveTicks();
+
+    /**
+     * Gets the Bad Omen level of this raid.
+     *
+     * @return Bad Omen level (between 0 and 5)
+     */
+    int getBadOmenLevel();
+
+    /**
+     * Sets the Bad Omen level.
+     * <br>
+     * If the level is higher than 1, there will be an additional wave that as
+     * strong as the final wave.
+     *
+     * @param badOmenLevel new Bad Omen level (from 0-5)
+     * @throws IllegalArgumentException if invalid Bad Omen level
+     */
+    void setBadOmenLevel(int badOmenLevel);
+
+    /**
+     * Gets the center location where the raid occurs.
+     *
+     * @return location
+     */
+    @NotNull
+    Location getLocation();
+
+    /**
+     * Gets the current status of the raid.
+     * <br>
+     * Do not use this method to check if the raid has been started, call
+     * {@link #isStarted()} instead.
+     *
+     * @return Raids status
+     */
+    @NotNull
+    RaidStatus getStatus();
+
+    /**
+     * Gets the number of raider groups which have spawned.
+     *
+     * @return total spawned groups
+     */
+    int getSpawnedGroups();
+
+    /**
+     * Gets the number of raider groups which would spawn.
+     * <br>
+     * This also includes the group which spawns in the additional wave (if
+     * present).
+     *
+     * @return total groups
+     */
+    int getTotalGroups();
+
+    /**
+     * Gets the number of waves in this raid (exclude the additional wave).
+     *
+     * @return number of waves
+     */
+    int getTotalWaves();
+
+    /**
+     * Gets the sum of all raider's health.
+     *
+     * @return total raiders health
+     */
+    float getTotalHealth();
+
+    /**
+     * Get the UUID of all heroes in this raid.
+     *
+     * @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();
+
+    /**
+     * Represents the status of a {@link Raid}.
+     */
+    public enum RaidStatus {
+
+        /**
+         * The raid is in progress.
+         */
+        ONGOING,
+        /**
+         * The raid was beaten by heroes.
+         */
+        VICTORY,
+        /**
+         * The village has fallen (i.e. all villagers died).
+         */
+        LOSS,
+        /**
+         * The raid was terminated.
+         */
+        STOPPED;
+    }
+}