Package net.nextinfinity.core.classes

Interface GameClass

All Known Implementing Classes:

CoreGameClass

public interface GameClass

The GameClass object represents a game class, or kit. These should be accessed with the ClassManager object and not created manually.

See Also:

ClassManager

Method Summary

Modifier and Type	Method	Description
void	addEffect(org.bukkit.potion.PotionEffect effect)	Adds a potion effect to the class.
void	addItem(org.bukkit.inventory.ItemStack item)	Adds an item to the set of items for the class.
org.bukkit.inventory.ItemStack[]	getArmor()	Gets the set of armor items given to players for the class, if applicable.
org.bukkit.ChatColor	getColor()	Gets the color of the class represented by the GameClass object.
java.util.List<org.bukkit.potion.PotionEffect>	getEffects()	Gets all potion effects belonging to the class.
org.bukkit.inventory.ItemStack	getGUIItem()	Returns the item which is used to represent the class in the class selection GUI if the entity has access to the class.
org.bukkit.inventory.ItemStack[]	getItems()	Gets the items given to players for the class, if applicable.
org.bukkit.inventory.ItemStack	getLockedItem()	Returns the item which is used to represent the class in the class selection GUI if the entity does not have access to the class.
java.lang.String	getName()	Gets the name of the class represented by the GameClass object.
java.lang.String	getPermission()	Gets the permission required for access to the class in-game.
void	setBoots(org.bukkit.inventory.ItemStack boots)	Sets the boots for the class.
void	setChestplate(org.bukkit.inventory.ItemStack chestplate)	Sets the chestplate for the class.
void	setGUIItem(org.bukkit.inventory.ItemStack item)	Sets the GUI item for the class.
void	setHelmet(org.bukkit.inventory.ItemStack helmet)	Sets the helmet for the class.
void	setLeggings(org.bukkit.inventory.ItemStack leggings)	Sets the leggings for the class.

Method Detail

getName

java.lang.String getName()

Gets the name of the class represented by the GameClass object.

Returns:

the name of the class

getColor

org.bukkit.ChatColor getColor()

Gets the color of the class represented by the GameClass object.

Returns:

the color of the class, as a ChatColor

getPermission

java.lang.String getPermission()

Gets the permission required for access to the class in-game. This is [game permission].class.[class name with no spaces]

Returns:

the permission for the class

getGUIItem

org.bukkit.inventory.ItemStack getGUIItem()

Returns the item which is used to represent the class in the class selection GUI if the entity has access to the class.

Returns:

the item used in the GUI

getLockedItem

org.bukkit.inventory.ItemStack getLockedItem()

Returns the item which is used to represent the class in the class selection GUI if the entity does not have access to the class.

Returns:

the locked variation of the item used in the GUI

setGUIItem

void setGUIItem(org.bukkit.inventory.ItemStack item)

Sets the GUI item for the class. This is set in class loading and usually should not be altered.

Parameters:

item - the item to be used in the class selection GUI

getItems

org.bukkit.inventory.ItemStack[] getItems()

Gets the items given to players for the class, if applicable.

Returns:

the set of items for the class

addItem

void addItem(org.bukkit.inventory.ItemStack item)

Adds an item to the set of items for the class. This is done in class loading and usually should not be altered.

Parameters:

item - the item to be added

setHelmet

void setHelmet(org.bukkit.inventory.ItemStack helmet)

Sets the helmet for the class. This is done in class loading and usually should not be altered.

Parameters:

helmet - the helmet item

setChestplate

void setChestplate(org.bukkit.inventory.ItemStack chestplate)

Sets the chestplate for the class. This is done in class loading and usually should not be altered.

Parameters:

chestplate - the chestplate item

setLeggings

void setLeggings(org.bukkit.inventory.ItemStack leggings)

Sets the leggings for the class. This is done in class loading and usually should not be altered.

Parameters:

leggings - the leggings item

setBoots

void setBoots(org.bukkit.inventory.ItemStack boots)

Sets the boots for the class. This is done in class loading and usually should not be altered.

Parameters:

boots - the boots item

getArmor

org.bukkit.inventory.ItemStack[] getArmor()

Gets the set of armor items given to players for the class, if applicable.

Returns:

the set of armor for the class

getEffects

java.util.List<org.bukkit.potion.PotionEffect> getEffects()

Gets all potion effects belonging to the class.

Returns:

the list of all potion effects

addEffect

void addEffect(org.bukkit.potion.PotionEffect effect)

Adds a potion effect to the class.

Parameters:

effect - the potion effect to add