Package net.nextinfinity.core.arena.impl

Class CoreArena

java.lang.Object

net.nextinfinity.core.arena.impl.CoreArena

All Implemented Interfaces:

Arena

public class CoreArena
extends java.lang.Object
implements Arena

Constructor Summary

Constructors

Constructor	Description
CoreArena(Game game, java.lang.String name, org.bukkit.World world)

Method Summary

Modifier and Type	Method	Description
boolean	addPlayer(GamePlayer player)	Attempts to add a player to the arena.
void	addSpawn(org.bukkit.Location spawn)	Adds a spawn to the arena and categorizes it as a free-for-all spawn.
void	addSpawn(org.bukkit.Location spawn, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreArena

public CoreArena(Game game,
                 java.lang.String name,
                 org.bukkit.World world)

Method Detail

addPlayer

public boolean addPlayer(GamePlayer player)

Description copied from interface: Arena

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.

Specified by:

addPlayer in interface Arena

Parameters:

player - the GamePlayer to attempt to add

Returns:

true if the action is successful, false otherwise

removePlayer

public void removePlayer(GamePlayer player)

Description copied from interface: Arena

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

Specified by:

removePlayer in interface Arena

Parameters:

player - the GamePlayer to remove

addSpectator

public boolean addSpectator(GamePlayer player)

Description copied from interface: Arena

Attempts to add a spectator to the arena.

Specified by:

addSpectator in interface Arena

Parameters:

player - the GamePlayer to attempt to add

Returns:

true is the action is successful, false otherwise

removeSpectator

public void removeSpectator(GamePlayer player)

Description copied from interface: Arena

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

Specified by:

removeSpectator in interface Arena

Parameters:

player - the GamePlayer to remove

spawnPlayer

public void spawnPlayer(GamePlayer player)

Description copied from interface: Arena

Spawns a entity in the arena.

Specified by:

spawnPlayer in interface Arena

Parameters:

player - the entity to spawn

countdown

public void countdown()

Description copied from interface: Arena

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

Specified by:

countdown in interface Arena

start

public void start()

Description copied from interface: Arena

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

Specified by:

start in interface Arena

end

public void end()

Description copied from interface: Arena

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

Specified by:

end in interface Arena

getPlayers

public java.util.List<GamePlayer> getPlayers()

Description copied from interface: Arena

Gets the list of players currently playing in the arena.

Specified by:

getPlayers in interface Arena

Returns:

the list of players in the arena

getSpectators

public java.util.List<GamePlayer> getSpectators()

Description copied from interface: Arena

Gets the list of players currently spectating the arena.

Specified by:

getSpectators in interface Arena

Returns:

the list of spectators for the arena.

getState

public GameState getState()

Description copied from interface: Arena

Gets the state of the arena.

Specified by:

getState in interface Arena

Returns:

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

See Also:

GameState

getScoreboard

public ScoreboardManager getScoreboard()

Description copied from interface: Arena

Gets the ScoreboardManager of the arena.

Specified by:

getScoreboard in interface Arena

Returns:

the ScoreboardManager object for the arena.

See Also:

ScoreboardManager

getName

public java.lang.String getName()

Description copied from interface: Arena

Gets the name of the map for the arena.

Specified by:

getName in interface Arena

Returns:

the name of the arena's map

addSpawn

public void addSpawn(org.bukkit.Location spawn)

Description copied from interface: Arena

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

Specified by:

addSpawn in interface Arena

Parameters:

spawn - the location of the spawn to add

addSpawn

public void addSpawn(org.bukkit.Location spawn,
                     Team team)

Description copied from interface: Arena

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

Specified by:

addSpawn in interface Arena

Parameters:

spawn - the location of the spawn to add

team - the team to associate the spawn with

setPregame

public void setPregame(org.bukkit.Location pregame)

Description copied from interface: Arena

Sets the pregame teleport location for the arena.

Specified by:

setPregame in interface Arena

Parameters:

pregame - the location to teleport players before the game

getPregame

public org.bukkit.Location getPregame()

Description copied from interface: Arena

Gets the pregame teleport location for the arena.

Specified by:

getPregame in interface Arena

Returns:

the location to teleport players before the game

setSpectatorSpawn

public void setSpectatorSpawn(org.bukkit.Location spectatorSpawn)

Description copied from interface: Arena

Sets the spectator teleport location for the arena.

Specified by:

setSpectatorSpawn in interface Arena

Parameters:

spectatorSpawn - the location to teleport spectators initially

getWorld

public org.bukkit.World getWorld()

Description copied from interface: Arena

Gets the World of the arena.

Specified by:

getWorld in interface Arena

Returns:

the World the arena is in