Package net.nextinfinity.core.arena

Interface Arena

All Known Implementing Classes:

CoreArena

public interface Arena

Method Summary

Modifier and Type	Method	Description
boolean	addPlayer(GamePlayer player)	Attempts to add a player to the arena.
void	addSpawn(org.bukkit.Location location)	Adds a spawn to the arena and categorizes it as a free-for-all spawn.
void	addSpawn(org.bukkit.Location location, Team team)	Adds a spawn the the arena and associates it with a certain team
boolean	addSpectator(GamePlayer player)	Attempts to add a spectator to the arena.
void	countdown()	Begins the countdown in the arena, which signifies a transition from the lobby state to the in-game state.
void	end()	Ends the arena, removes all current players, and awards the winner(s).
java.lang.String	getName()	Gets the name of the map for the arena.
java.util.List<GamePlayer>	getPlayers()	Gets the list of players currently playing in the arena.
org.bukkit.Location	getPregame()	Gets the pregame teleport location for the arena.
ScoreboardManager	getScoreboard()	Gets the ScoreboardManager of the arena.
java.util.List<GamePlayer>	getSpectators()	Gets the list of players currently spectating the arena.
GameState	getState()	Gets the state of the arena.
org.bukkit.World	getWorld()	Gets the World of the arena.
void	removePlayer(GamePlayer player)	Removes a player from the arena if they are playing in it.
void	removeSpectator(GamePlayer player)	Removes a player from the arena if they are spectating it.
void	setPregame(org.bukkit.Location pregame)	Sets the pregame teleport location for the arena.
void	setSpectatorSpawn(org.bukkit.Location spectatorSpawn)	Sets the spectator teleport location for the arena.
void	spawnPlayer(GamePlayer player)	Spawns a entity in the arena.
void	start()	Starts the arena, and begins the in-game state.

Method Detail

addPlayer

boolean addPlayer(GamePlayer player)

Attempts to add a player to the arena. Will fail if the arena is not in the lobby state, is full, or the entity is in another arena.

Parameters:

player - the GamePlayer to attempt to add

Returns:

true if the action is successful, false otherwise

removePlayer

void removePlayer(GamePlayer player)

Removes a player from the arena if they are playing in it.

Parameters:

player - the GamePlayer to remove

addSpectator

boolean addSpectator(GamePlayer player)

Attempts to add a spectator to the arena.

Parameters:

player - the GamePlayer to attempt to add

Returns:

true is the action is successful, false otherwise

removeSpectator

void removeSpectator(GamePlayer player)

Removes a player from the arena if they are spectating it.

Parameters:

player - the GamePlayer to remove

spawnPlayer

void spawnPlayer(GamePlayer player)

Spawns a entity in the arena.

Parameters:

player - the entity to spawn

countdown

void countdown()

Begins the countdown in the arena, which signifies a transition from the lobby state to the in-game state.

start

void start()

Starts the arena, and begins the in-game state.

end

void end()

Ends the arena, removes all current players, and awards the winner(s).

getPlayers

java.util.List<GamePlayer> getPlayers()

Gets the list of players currently playing in the arena.

Returns:

the list of players in the arena

getSpectators

java.util.List<GamePlayer> getSpectators()

Gets the list of players currently spectating the arena.

Returns:

the list of spectators for the arena.

getState

GameState getState()

Gets the state of the arena.

Returns:

the GameState the arena is currently in - lobby, starting, or ingame

See Also:

GameState

getScoreboard

ScoreboardManager getScoreboard()

Gets the ScoreboardManager of the arena.

Returns:

the ScoreboardManager object for the arena.

See Also:

ScoreboardManager

getName

java.lang.String getName()

Gets the name of the map for the arena.

Returns:

the name of the arena's map

addSpawn

void addSpawn(org.bukkit.Location location)

Adds a spawn to the arena and categorizes it as a free-for-all spawn.

Parameters:

location - the location of the spawn to add

addSpawn

void addSpawn(org.bukkit.Location location,
              Team team)

Adds a spawn the the arena and associates it with a certain team

Parameters:

location - the location of the spawn to add

team - the team to associate the spawn with

setPregame

void setPregame(org.bukkit.Location pregame)

Sets the pregame teleport location for the arena.

Parameters:

pregame - the location to teleport players before the game

getPregame

org.bukkit.Location getPregame()

Gets the pregame teleport location for the arena.

Returns:

the location to teleport players before the game

setSpectatorSpawn

void setSpectatorSpawn(org.bukkit.Location spectatorSpawn)

Sets the spectator teleport location for the arena.

Parameters:

spectatorSpawn - the location to teleport spectators initially

getWorld

org.bukkit.World getWorld()

Gets the World of the arena.

Returns:

the World the arena is in