fr.aumgn.dac2.arena

Class Arena

java.lang.Object

fr.aumgn.dac2.arena.Arena

public class Arena
extends Object

Constructor Summary

Constructors

Constructor and Description
Arena(String name, World world)

Method Summary

Methods

Modifier and Type	Method and Description
Diving	getDiving()
String	getName()
Pool	getPool()
StartRegion	getStartRegion()
SurroundingRegion	getSurroundingRegion()
World	getWorld()
boolean	isComplete() Checks if this arena is complete.
boolean	isIn(World world)
Diving	safeGetDiving(DAC dac) Returns the diving board if defined or throws an exception if not.
Pool	safeGetPool(DAC dac) Returns the pool if defined or throws an exception if not.
StartRegion	safeGetStartRegion(DAC dac) Returns the start region if defined or throws an exception if not.
SurroundingRegion	safeGetSurroundingRegion(DAC dac) Returns the surrounding region if defined or throws an exception if not.
void	setDiving(Diving diving)
void	setPool(Pool pool)
void	setStartRegion(StartRegion region)
void	setSurroundingRegion(SurroundingRegion surrounding) Sets the surrrounding region.

Methods inherited from class java.lang.Object

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

Constructor Detail

Arena

public Arena(String name,
     World world)

Method Detail

getName

public String getName()

getWorld

public World getWorld()

isIn

public boolean isIn(World world)

isComplete

public boolean isComplete()

Checks if this arena is complete. An arena is considered complete if it has :

• A pool
• A start region
• A diving

getPool

public Pool getPool()

safeGetPool

public Pool safeGetPool(DAC dac)

Returns the pool if defined or throws an exception if not.

Parameters:

dac - the main DAC instance.

Returns:

the pool

Throws:

ArenaComponentUndefined

setPool

public void setPool(Pool pool)

getStartRegion

public StartRegion getStartRegion()

safeGetStartRegion

public StartRegion safeGetStartRegion(DAC dac)

Returns the start region if defined or throws an exception if not.

Parameters:

dac - the main DAC instance.

Returns:

the start region

Throws:

ArenaComponentUndefined

setStartRegion

public void setStartRegion(StartRegion region)

getDiving

public Diving getDiving()

safeGetDiving

public Diving safeGetDiving(DAC dac)

Returns the diving board if defined or throws an exception if not.

Parameters:

dac - the main DAC instance.

Returns:

the diving board

Throws:

ArenaComponentUndefined

setDiving

public void setDiving(Diving diving)

getSurroundingRegion

public SurroundingRegion getSurroundingRegion()

safeGetSurroundingRegion

public SurroundingRegion safeGetSurroundingRegion(DAC dac)

Returns the surrounding region if defined or throws an exception if not. The surrounding region doesn't need to be manually defined. It is also considered defined if the pool and the diving are.

Parameters:

dac - the main DAC instance.

Returns:

the surrounding region

Throws:

ArenaComponentUndefined

setSurroundingRegion

public void setSurroundingRegion(SurroundingRegion surrounding)

Sets the surrrounding region. This will override the region wich is automatically defined using the pool and the diving.

Parameters:

surrounding - the new manually defined surrounding region.