net.caseif.flint.arena

Interface Arena

All Superinterfaces:

Component<Minigame>, ComponentOwner, MetadataHolder

public interface Arena
extends MetadataHolder, ComponentOwner, Component<Minigame>

Represents an arena in which rounds may take place.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
int	addSpawnPoint(Location3D spawn) Adds the given Location3D to this Arena's possible spawn points.
com.google.common.base.Optional<ChallengerListingLobbySign>	createChallengerListingLobbySign(Location3D location, int index) Attempts to register a ChallengerListingLobbySign at the given location.
Round	createRound() Creates a new Round in this Arena with the default LifecycleStages.
Round	createRound(com.google.common.collect.ImmutableSet<LifecycleStage> stages) Creates a new Round in this Arena.
com.google.common.base.Optional<StatusLobbySign>	createStatusLobbySign(Location3D location) Attempts to register a StatusLobbySign at the given location.
Boundary	getBoundary() Gets the Boundary which this Arena is contained within.
java.lang.String	getId() Gets the identifier of this Arena.
com.google.common.base.Optional<LobbySign>	getLobbySignAt(Location3D location) Gets the LobbySign at the given Location3D, if present.
com.google.common.collect.ImmutableList<LobbySign>	getLobbySigns() Gets an ImmutableList of LobbySigns registered for this Arena.
Minigame	getMinigame() Gets the Minigame this Arena is owned by.
java.lang.String	getName() Gets the "friendly" name of this Arena, as displayed to users.
com.google.common.base.Optional<Round>	getRound() Gets the Round contained by this Arena.
com.google.common.collect.ImmutableMap<java.lang.Integer,Location3D>	getSpawnPoints() Returns an ImmutableMap of points at which players may spawn upon entering this arena, mapped to their respective IDs.
java.lang.String	getWorld() Gets the name of the world which contains this Arena.
void	removeSpawnPoint(int index) Removes the spawn point of the given index from this Arena.
void	removeSpawnPoint(Location3D location) Removes the spawn point(s) at the given location from this Arena.
void	rollback() Rolls this Arena's its state immediately prior to a Round having been created in it.
void	setBoundary(Boundary bound) Sets the Boundary which this Arena is contained within.

Methods inherited from interface net.caseif.flint.metadata.MetadataHolder

getMetadata

Methods inherited from interface net.caseif.flint.component.Component

getOwner

Method Detail

getMinigame

Minigame getMinigame()
              throws OrphanedComponentException

Gets the Minigame this Arena is owned by.

Note: This a convenience method for Component.getOwner().

Returns:

The Minigame this Arena is owned by

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getId

java.lang.String getId()
                throws OrphanedComponentException

Gets the identifier of this Arena.

Returns:

The identifier of this Arena

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getName

java.lang.String getName()
                  throws OrphanedComponentException

Gets the "friendly" name of this Arena, as displayed to users.

Returns:

The "friendly" name of this Arena, as displayed to users, or its ID if one is not set

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getWorld

java.lang.String getWorld()
                   throws OrphanedComponentException

Gets the name of the world which contains this Arena.

Returns:

The name of the world which contains this Arena

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getBoundary

Boundary getBoundary()
              throws OrphanedComponentException

Gets the Boundary which this Arena is contained within.

Returns:

The Boundary which this Arena is contained

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details) within

Since:

1.0

setBoundary

void setBoundary(Boundary bound)
          throws OrphanedComponentException

Sets the Boundary which this Arena is contained within.

Parameters:

bound - The new Boundary which this Arena is to be contained within

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getSpawnPoints

com.google.common.collect.ImmutableMap<java.lang.Integer,Location3D> getSpawnPoints()
                                                                             throws OrphanedComponentException

Returns an ImmutableMap of points at which players may spawn upon entering this arena, mapped to their respective IDs.

Returns:

An immutable BiMap of points at which players may spawn upon entering this arena, mapped to their respective IDs

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

addSpawnPoint

int addSpawnPoint(Location3D spawn)
           throws OrphanedComponentException

Adds the given Location3D to this Arena's possible spawn points.

Parameters:

spawn - The Location3D to add as a new spawn point

Returns:

The index of the new spawn point

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

removeSpawnPoint

void removeSpawnPoint(int index)
               throws OrphanedComponentException

Removes the spawn point of the given index from this Arena.

Parameters:

index - The index of the spawn point to remove

Throws:

java.lang.IllegalArgumentException - If a spawn point at the given index does not exist

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

removeSpawnPoint

void removeSpawnPoint(Location3D location)
               throws OrphanedComponentException

Removes the spawn point(s) at the given location from this Arena.

Parameters:

location - The location of the spawn point(s) to remove

Throws:

java.lang.IllegalArgumentException - If no spawn points are defined at the given location

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getRound

com.google.common.base.Optional<Round> getRound()
                                         throws OrphanedComponentException

Gets the Round contained by this Arena.

Returns:

The Round contained by this Arena

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

createRound

Round createRound(com.google.common.collect.ImmutableSet<LifecycleStage> stages)
           throws java.lang.IllegalArgumentException,
                  java.lang.IllegalStateException,
                  OrphanedComponentException

Creates a new Round in this Arena.

Parameters:

stages - A LinkedHashSet containing LifecycleStages to define for the new Round

Returns:

The newly created Round.

Throws:

java.lang.IllegalArgumentException - If stages contains an empty set

java.lang.IllegalStateException - If a Round already exists in this Arena

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

createRound

Round createRound()
           throws java.lang.IllegalStateException,
                  OrphanedComponentException

Creates a new Round in this Arena with the default LifecycleStages.

Returns:

The newly created Round.

Throws:

java.lang.IllegalStateException - If a Round already exists in this Arena, or if the default LifecycleStages have not been set as a config option

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLobbySigns

com.google.common.collect.ImmutableList<LobbySign> getLobbySigns()
                                                          throws OrphanedComponentException

Gets an ImmutableList of LobbySigns registered for this Arena.

Returns:

An ImmutableList of LobbySigns registered for this Arena

Throws:

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

getLobbySignAt

com.google.common.base.Optional<LobbySign> getLobbySignAt(Location3D location)
                                                   throws java.lang.IllegalArgumentException,
                                                          OrphanedComponentException

Gets the LobbySign at the given Location3D, if present.

Parameters:

location - The location at which to search for a LobbySign

Returns:

The LobbySign at the given Location3D, or Optional.absent() if none is registered

Throws:

java.lang.IllegalArgumentException - If location does not define a world

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

createStatusLobbySign

com.google.common.base.Optional<StatusLobbySign> createStatusLobbySign(Location3D location)
                                                                throws java.lang.IllegalArgumentException,
                                                                       OrphanedComponentException

Attempts to register a StatusLobbySign at the given location.

Parameters:

location - The location to register the sign at

Returns:

The newly-registered StatusLobbySign, or Optional.absent() if the passed location does not contain a sign type or already contains a registered LobbySign

Throws:

java.lang.IllegalArgumentException - If location does not define a world

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

createChallengerListingLobbySign

com.google.common.base.Optional<ChallengerListingLobbySign> createChallengerListingLobbySign(Location3D location,
                                                                                             int index)
                                                                                      throws java.lang.IllegalArgumentException,
                                                                                             OrphanedComponentException

Attempts to register a ChallengerListingLobbySign at the given location.

Parameters:

location - The location to register the sign at

index - The index of the sign (see ChallengerListingLobbySign.getIndex() for more info

Returns:

The newly-registered StatusLobbySign, or Optional.absent() if the passed location does not contain a sign type or already contains a registered LobbySign

Throws:

java.lang.IllegalArgumentException - If location does not define a world

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0

rollback

void rollback()
       throws java.lang.IllegalStateException,
              OrphanedComponentException

Rolls this Arena's its state immediately prior to a Round having been created in it.

Throws:

java.lang.IllegalStateException - If no Round has taken place in this Arena since the last call to this method upon it

OrphanedComponentException - If this object is orphaned (see Component for details)

Since:

1.0