Package org.spongepowered.api.raid
Interface Raid
public interface Raid
-
Method Summary
Modifier and TypeMethodDescriptionbossBar()
Gets theBossBar
being displayed to clients of this raid.Gets the currentRaidWave
of this raid.double
health()
Gets the health of this raid.status()
Gets theRaidStatus
of this raid.int
Gets the amount ofwaves
this raid plans to execute.waves()
Gets all of thewaves
that have occurred or are occurring in this raid.world()
Gets theServerWorld
this raid is taking place in.
-
Method Details
-
world
ServerWorld world()Gets theServerWorld
this raid is taking place in.- Returns:
- The world
-
bossBar
BossBar bossBar()Gets theBossBar
being displayed to clients of this raid.- Returns:
- The boss bar
-
status
RaidStatus status()Gets theRaidStatus
of this raid.- Returns:
- The raid status
-
currentWave
Gets the currentRaidWave
of this raid.- Returns:
- The current wave or
Optional.empty()
if no waves are currently running
-
waves
Gets all of thewaves
that have occurred or are occurring in this raid.- Returns:
- The waves
-
totalWaveAmount
int totalWaveAmount()Gets the amount ofwaves
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 theRaider's
Living.health()
. As long as the raider was added to aRaidWave
as part of the health.- Returns:
- The health
-