eu.wauz.wauzcore.system.instances

Class InstanceMobArena

java.lang.Object

eu.wauz.wauzcore.system.instances.InstanceMobArena

public class InstanceMobArena
extends java.lang.Object

An arena that spawns waves of mobs in an instance world.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private int	currentWave The current wave number.
private int	maximumWave The maximum wave number.
private int	mobsLeft How many mobs of the current wave are left.
private java.util.List<java.util.List<MobSpawn>>	waves The list of lists of mobs that spawn in arena waves.
private org.bukkit.World	world The instance world of the arena.

Constructor Summary

Constructors

Constructor and Description
InstanceMobArena(InstanceMobArena arena, org.bukkit.World world) Constructs an arena, that is an exact copy of another arena.
InstanceMobArena(java.lang.String instanceName) Creates an arena template, based on the instance file in the /WauzCore/InstanceData folder.

Method Summary

Modifier and Type	Method and Description
void	broadcastMessage(java.lang.String message, org.bukkit.Sound sound) Broadcasts a title message with sound effect to all players in the arena.
void	checkIfNewWaveShouldStart() Starts a new wave, if requirements are met.
void	decreaseMobCount() Decreases how many mobs are left in the current wave.
int	getCurrentWave()
int	getMaximumWave()
int	getMobsLeft()
java.util.List<java.util.List<MobSpawn>>	getWaves()
void	handOutMedals() Give every player in the arena a medal for completing the current wave.
void	increaseMobCount() Increases how many mobs are left in the current wave.
void	setCurrentWave(int currentWave)
void	setMaximumWave(int maximumWave)
void	setWaves(java.util.List<java.util.List<MobSpawn>> waves)
void	startNewWave() Increases the wave counter and spawns the mobs for the new wave.
static void	tryToDecreaseMobCount(org.bukkit.entity.Entity entity) If the given entity is part of a mob arena, the arena's mob count gets decreased.
static void	tryToIncreaseMobCount(org.bukkit.entity.Entity entity) If the given entity is part of a mob arena, the arena's mob count gets increased.
void	tryToManuallyStartNewWave(org.bukkit.entity.Player player) Lets a player try to start a new wave manually.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

world

private org.bukkit.World world

The instance world of the arena.

currentWave

private int currentWave

The current wave number.

maximumWave

private int maximumWave

The maximum wave number.

waves

private java.util.List<java.util.List<MobSpawn>> waves

The list of lists of mobs that spawn in arena waves.

mobsLeft

private int mobsLeft

How many mobs of the current wave are left.

Constructor Detail

InstanceMobArena

public InstanceMobArena(java.lang.String instanceName)

Creates an arena template, based on the instance file in the /WauzCore/InstanceData folder.

Parameters:

instanceName - The name of the instance, the arena is located in.

InstanceMobArena

public InstanceMobArena(InstanceMobArena arena,
                        org.bukkit.World world)

Constructs an arena, that is an exact copy of another arena.

Parameters:

arena - The arena to clone.

world - The instance world for the cloned arena.

Method Detail

tryToManuallyStartNewWave

public void tryToManuallyStartNewWave(org.bukkit.entity.Player player)

Lets a player try to start a new wave manually. Only works when a set of 5 waves is completed and there are still waves left.

Parameters:

player - The player who tries to start the wave.

See Also:

startNewWave()

checkIfNewWaveShouldStart

public void checkIfNewWaveShouldStart()

Starts a new wave, if requirements are met. Broadcasts a message when all waves have been completed.

See Also:

startNewWave(), broadcastMessage(String, Sound)

startNewWave

public void startNewWave()

Increases the wave counter and spawns the mobs for the new wave. Also broadcasts a message to show the current wave number.

See Also:

MobSpawn.spawn(World), broadcastMessage(String, Sound), WauzPlayerScoreboard.scheduleScoreboardRefresh(Player)

broadcastMessage

public void broadcastMessage(java.lang.String message,
                             org.bukkit.Sound sound)

Broadcasts a title message with sound effect to all players in the arena.

Parameters:

message - The message to display.

sound - The sound effect to play.

handOutMedals

public void handOutMedals()

Give every player in the arena a medal for completing the current wave.

See Also:

PlayerCollectionConfigurator.setCharacterMedals(Player, long)

tryToIncreaseMobCount

public static void tryToIncreaseMobCount(org.bukkit.entity.Entity entity)

If the given entity is part of a mob arena, the arena's mob count gets increased.

Parameters:

entity - The entity that could have appeared in an arena.

increaseMobCount

public void increaseMobCount()

Increases how many mobs are left in the current wave.

tryToDecreaseMobCount

public static void tryToDecreaseMobCount(org.bukkit.entity.Entity entity)

If the given entity is part of a mob arena, the arena's mob count gets decreased.

Parameters:

entity - The entity that could have disappeared from an arena.

decreaseMobCount

public void decreaseMobCount()

Decreases how many mobs are left in the current wave.

See Also:

checkIfNewWaveShouldStart()

getCurrentWave

public int getCurrentWave()

Returns:

The current wave number.

setCurrentWave

public void setCurrentWave(int currentWave)

Parameters:

currentWave - The new current wave number.

getMaximumWave

public int getMaximumWave()

Returns:

The maximum wave number.

setMaximumWave

public void setMaximumWave(int maximumWave)

Parameters:

maximumWave - The new maximum wave number.

getWaves

public java.util.List<java.util.List<MobSpawn>> getWaves()

Returns:

The list of lists of mobs that spawn in arena waves.

setWaves

public void setWaves(java.util.List<java.util.List<MobSpawn>> waves)

Parameters:

waves - The new list of lists of mobs that spawn in arena waves.

getMobsLeft

public int getMobsLeft()

Returns:

How many mobs of the current wave are left.