Package org.spongepowered.api.raid

Interface RaidWave

public interface RaidWave

  • Method Details

    • raid

      Raid raid()
      Gets the Raid this wave is a part of.
      Returns:
      The raid

    • isBonus

      boolean isBonus()
      Determines if this wave was a bonus of the Raid.

      Bonus waves are always spawned after the final wave.

      Bonus waves exist because PotionEffectTypes.BAD_OMEN had a level greater than 1.

      Returns:
      True if bonus, false if not

    • isFinal

      boolean isFinal()
      Determines if this wave was the final wave of the Raid.

      Whether a wave is final depends on the Difficulty of the world.

      If this wave is final, there may be bonus waves after the wave finishes.

      Returns:
      True if the final wave, false if not

    • leader

      Optional<Raider> leader()
      Gets the leader of this wave.
      Returns:
      The leader or Optional.empty() if not present

    • addRaider

      boolean addRaider(Raider raider, boolean addToRaidHealth)
      Adds a Raider to this wave.
      Parameters:
      raider - The raider
      addToRaidHealth - Whether to add on to a Raid's health
      Returns:
      True if raider was added, false if not

    • removeRaider

      boolean removeRaider(Raider raider)
      Removes a Raider from this wave.
      Parameters:
      raider - The raider to remove
      Returns:
      True if remove succeeded, false if not (or wasn't in the wave to begin with)