Package org.spongepowered.api.raid
Interface RaidWave
-
public interface RaidWave
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanaddRaider(Raider raider, boolean addToRaidHealth)Adds aRaiderto this wave.booleanisBonus()Determines if this wave was a bonus of theRaid.booleanisFinal()Determines if this wave was the final wave of theRaid.Optional<Raider>leader()Gets theleaderof this wave.Raidraid()Gets theRaidthis wave is a part of.booleanremoveRaider(Raider raider)Removes aRaiderfrom this wave.
-
-
-
Method Detail
-
isBonus
boolean isBonus()
Determines if this wave was a bonus of theRaid.Bonus waves are always spawned after the final wave.
Bonus waves exist because
PotionEffectTypes.BAD_OMENhad a level greater than 1.- Returns:
- True if bonus, false if not
-
isFinal
boolean isFinal()
Determines if this wave was the final wave of theRaid.Whether a wave is final depends on the
Difficultyof 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 theleaderof this wave.- Returns:
- The leader or
Optional.empty()if not present
-
addRaider
boolean addRaider(Raider raider, boolean addToRaidHealth)
Adds aRaiderto this wave.- Parameters:
raider- The raideraddToRaidHealth- Whether to add on to aRaid'shealth- Returns:
- True if raider was added, false if not
-
-