Package org.spongepowered.api.raid

Interface Raid

  • public interface Raid

    • Method Detail

      • bossBar

        BossBar bossBar()
        Gets the BossBar being displayed to clients of this raid.
        Returns:
        The boss bar

      • setBossBar

        void setBossBar​(BossBar bossBar)
        Sets the BossBar being displayed to clients of this raid.
        Parameters:
        bossBar - The boss bar

      • currentWave

        java.util.Optional<RaidWave> currentWave()
        Gets the current RaidWave of this raid.
        Returns:
        The current wave or Optional.empty() if no waves are currently running

      • waves

        java.util.List<RaidWave> waves()
        Gets all of the waves that have occurred or are occurring in this raid.
        Returns:
        The waves

      • totalWaveAmount

        int totalWaveAmount()
        Gets the amount of waves this raid plans to execute.

        In vanilla, a raid determines wave amounts based on difficulty:

        Keep in mind that wave amount will be affected by waves added by plugins
        Returns:
        The total wave amount

      • health

        double health()
        Gets the health of this raid. Health is calculated by the sum of all of the Raider's Living.health(). As long as the raider was added to a RaidWave as part of the health.
        Returns:
        The health