Package net.nextinfinity.core.arena

Interface ArenaManager

All Known Implementing Classes:

CoreArenaManager

public interface ArenaManager

The ArenaManager object is a management interface for individual Arena objects.

Method Summary

Modifier and Type	Method	Description
void	clearArenas()	Unload and delete all arena worlds.
ArenaEditor	createEditor(java.lang.String name, GamePlayer player)	Creates an editing session for an arena.
boolean	createSchematic(GamePlayer player, java.lang.String name)	Creates a schematic from the player's WorldEdit selection and places the schematic in the game's schematic folder.
void	deleteWorld(org.bukkit.World world)	Unloads a World from Bukkit and deletes it from the disk.
Arena	getArena(java.lang.String name)	Gets the arena with a certain name.
java.util.Map<java.lang.String,java.util.List<Arena>>	getArenaMap()	Gets the map of all active arenas, where the key is the name of the arena and the list is all arenas running for that map.
ArenaMenu	getMenu()	Gets the ArenaMenu object
boolean	isArenaWorld(org.bukkit.World world)	Check if a World belongs to an Arena.
void	loadArenas()	Loads stored data for arenas into memory.
void	removeArena(Arena arena)	Removes an Arena object from memory.
void	setArenaClass(java.lang.Class<? extends Arena> newClass)	Alters the Java class to be used for arenas, in case a game wishes to use a custom arena class.
void	setLobby(org.bukkit.Location location)	Sets the global lobby the location.

Method Detail

getArena

Arena getArena(java.lang.String name)

Gets the arena with a certain name.

Parameters:

name - the name of the arena to search for

Returns:

the Arena object for the arena with the searched name

removeArena

void removeArena(Arena arena)

Removes an Arena object from memory.

Parameters:

arena - the arena to remove

loadArenas

void loadArenas()

Loads stored data for arenas into memory. This should usually only be called during game initialization.

clearArenas

void clearArenas()

Unload and delete all arena worlds.

createEditor

ArenaEditor createEditor(java.lang.String name,
                         GamePlayer player)

Creates an editing session for an arena.

Parameters:

name - the name of the arena to create the edit session for

player - the entity to apply the editing session to

Returns:

the created ArenaEditor object

See Also:

ArenaEditor

getMenu

ArenaMenu getMenu()

Gets the ArenaMenu object

Returns:

the ArenaMenu object

createSchematic

boolean createSchematic(GamePlayer player,
                        java.lang.String name)

Creates a schematic from the player's WorldEdit selection and places the schematic in the game's schematic folder.

Parameters:

player - the GamePlayer to whose Player is associated with the selection

name - the name of the schematic

Returns:

true if successful, false otherwise

setLobby

void setLobby(org.bukkit.Location location)

Sets the global lobby the location.

Parameters:

location - the new lobby location

getArenaMap

java.util.Map<java.lang.String,java.util.List<Arena>> getArenaMap()

Gets the map of all active arenas, where the key is the name of the arena and the list is all arenas running for that map.

Returns:

the Map of all active arenas

setArenaClass

void setArenaClass(java.lang.Class<? extends Arena> newClass)

Alters the Java class to be used for arenas, in case a game wishes to use a custom arena class. The new class must implement Arena. It may be helpful for custom arena classes to extend CoreArena, as this implements all necessary functions.

Parameters:

newClass - the new Java class to use for arenas

See Also:

CoreArena

isArenaWorld

boolean isArenaWorld(org.bukkit.World world)

Check if a World belongs to an Arena.

Parameters:

world - the world to check

Returns:

true if the World belongs to an Arena, false otherwise

deleteWorld

void deleteWorld(org.bukkit.World world)

Unloads a World from Bukkit and deletes it from the disk.

Parameters:

world - the World to delete