Package net.nextinfinity.core.arena.impl

Class CoreArenaManager

java.lang.Object

net.nextinfinity.core.arena.impl.CoreArenaManager

All Implemented Interfaces:

ArenaManager

public class CoreArenaManager
extends java.lang.Object
implements ArenaManager

Constructor Summary

Constructors

Constructor	Description
CoreArenaManager(Game game)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreArenaManager

public CoreArenaManager(Game game)

Method Detail

getArena

public Arena getArena(java.lang.String name)

Description copied from interface: ArenaManager

Gets the arena with a certain name.

Specified by:

getArena in interface ArenaManager

Parameters:

name - the name of the arena to search for

Returns:

the Arena object for the arena with the searched name

removeArena

public void removeArena(Arena arena)

Description copied from interface: ArenaManager

Removes an Arena object from memory.

Specified by:

removeArena in interface ArenaManager

Parameters:

arena - the arena to remove

loadArenas

public void loadArenas()

Description copied from interface: ArenaManager

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

Specified by:

loadArenas in interface ArenaManager

clearArenas

public void clearArenas()

Description copied from interface: ArenaManager

Unload and delete all arena worlds.

Specified by:

clearArenas in interface ArenaManager

createEditor

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

Description copied from interface: ArenaManager

Creates an editing session for an arena.

Specified by:

createEditor in interface ArenaManager

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

public ArenaMenu getMenu()

Description copied from interface: ArenaManager

Gets the ArenaMenu object

Specified by:

getMenu in interface ArenaManager

Returns:

the ArenaMenu object

createSchematic

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

Description copied from interface: ArenaManager

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

Specified by:

createSchematic in interface ArenaManager

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

public void setLobby(org.bukkit.Location location)

Description copied from interface: ArenaManager

Sets the global lobby the location.

Specified by:

setLobby in interface ArenaManager

Parameters:

location - the new lobby location

getArenaMap

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

Description copied from interface: ArenaManager

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.

Specified by:

getArenaMap in interface ArenaManager

Returns:

the Map of all active arenas

setArenaClass

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

Description copied from interface: ArenaManager

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.

Specified by:

setArenaClass in interface ArenaManager

Parameters:

newClass - the new Java class to use for arenas

See Also:

CoreArena

isArenaWorld

public boolean isArenaWorld(org.bukkit.World world)

Description copied from interface: ArenaManager

Check if a World belongs to an Arena.

Specified by:

isArenaWorld in interface ArenaManager

Parameters:

world - the world to check

Returns:

true if the World belongs to an Arena, false otherwise

deleteWorld

public void deleteWorld(org.bukkit.World world)

Description copied from interface: ArenaManager

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

Specified by:

deleteWorld in interface ArenaManager

Parameters:

world - the World to delete