Package net.nextinfinity.core.arena

Interface ArenaEditor

All Known Implementing Classes:

CoreArenaEditor

public interface ArenaEditor

The ArenaEditor object is created when an admin initializes an arena editing session. It may be used to add/remove spawns or perform other arena administration tasks.

Method Summary

Modifier and Type	Method	Description
void	addSpawn()	Adds a new spawn at the players current location.
void	close()	Closes the editing session and returns the entity to their previous state.
org.bukkit.inventory.Inventory	getMenu()	Gets the inventory menu for the ArenaEditor.
GamePlayer	getPlayer()	Gets the GamePlayer associated with the ArenaEditor
ArenaEditor	open()	Opens the editing session.
void	removeSpawn()	Removes the spawn at the players current location, if one exists.
void	setPregame()	Sets the pregame spawn to the player's current location.
void	setSpectator()	Sets the spectator spawn to the player's current location.

Method Detail

open

ArenaEditor open()

Opens the editing session. This should be called after the creation of the ArenaEditor object.
The entity will be teleported to a copy of the arena.

Returns:

the ArenaEditor object for the initialized editing session

close

void close()

Closes the editing session and returns the entity to their previous state.
It is at this point that the edited list of spawns is saved to the disk.

addSpawn

void addSpawn()

Adds a new spawn at the players current location.

removeSpawn

void removeSpawn()

Removes the spawn at the players current location, if one exists.

setPregame

void setPregame()

Sets the pregame spawn to the player's current location.

setSpectator

void setSpectator()

Sets the spectator spawn to the player's current location.

getPlayer

GamePlayer getPlayer()

Gets the GamePlayer associated with the ArenaEditor

Returns:

the GamePlayer using the ArenaEditor

getMenu

org.bukkit.inventory.Inventory getMenu()

Gets the inventory menu for the ArenaEditor.

Returns:

the Inventory object of the menu