Package org.spongepowered.api.raid

Interface Raid

public interface Raid

  • Method Details Link icon

    • world Link icon

      ServerWorld world()
      Gets the ServerWorld this raid is taking place in.
      Returns:
      The world

    • bossBar Link icon

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

    • status Link icon

      RaidStatus status()
      Gets the RaidStatus of this raid.
      Returns:
      The raid status

    • currentWave Link icon

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

    • waves Link icon

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

    • totalWaveAmount Link icon

      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 Link icon

      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