Package net.nextinfinity.core.classes

Interface ClassEditor

All Known Implementing Classes:

CoreClassEditor

public interface ClassEditor

The ClassEditor is an in-game editor to allow admins to create classes without having to manually edit files.

Method Summary

Modifier and Type	Method	Description
void	addEffect(java.lang.String potionType)	Adds a potion effect to the class.
void	close()	Closes the editing session.
org.bukkit.inventory.Inventory	getAddEffectMenu()	Gets the menu to add a new potion effect to the class.
org.bukkit.inventory.Inventory	getColorMenu()	Gets the menu to set the color for the class.
org.bukkit.inventory.Inventory	getCurrentEffectMenu()	Gets the menu of existing potion effects for the class.
org.bukkit.inventory.Inventory	getInventory()	Gets the primary inventory menu where items/armor may be edited and other menus may be accessed.
GamePlayer	getPlayer()	Gets the GamePlayer associated with the ClassEditor
void	open()	Opens the editing session.
void	removeEffect(java.lang.String potionType)	Removes a potion effect from the class.
void	setColor(org.bukkit.inventory.ItemStack wool)	Sets the ChatColor for the class to that associated with a wool ItemStack.

Method Detail

open

void open()

Opens the editing session. This should be called after the creation of the ClassEditor object.
The ClassEditor inventory menu will be opened for the player.

close

void close()

Closes the editing session.
It is at this point that the edited class data is saved to the disk.

setColor

void setColor(org.bukkit.inventory.ItemStack wool)

Sets the ChatColor for the class to that associated with a wool ItemStack. The wool must have the "color" NBT string set to a valid ChatColor.

Parameters:

wool - the wool object corresponding to the desired ChatColor

addEffect

void addEffect(java.lang.String potionType)

Adds a potion effect to the class. If the effect does not exist, it will be added at level 1, otherwise its level will be incremented.

Parameters:

potionType - the internal name of the potion effect to add

removeEffect

void removeEffect(java.lang.String potionType)

Removes a potion effect from the class. If the effect is level one, it will be removed, otherwise its level will be decremented.

Parameters:

potionType - the internal name of the potion effect to remove

getPlayer

GamePlayer getPlayer()

Gets the GamePlayer associated with the ClassEditor

Returns:

the GamePlayer using the ClassEditor

getInventory

org.bukkit.inventory.Inventory getInventory()

Gets the primary inventory menu where items/armor may be edited and other menus may be accessed.

Returns:

the main inventory menu

getColorMenu

org.bukkit.inventory.Inventory getColorMenu()

Gets the menu to set the color for the class.

Returns:

the color menu

getCurrentEffectMenu

org.bukkit.inventory.Inventory getCurrentEffectMenu()

Gets the menu of existing potion effects for the class.

Returns:

the current effect menu

getAddEffectMenu

org.bukkit.inventory.Inventory getAddEffectMenu()

Gets the menu to add a new potion effect to the class.

Returns:

the add effect menu