me.redstonefreak589.pcg.api

Class MenuItem

java.lang.Object

me.redstonefreak589.pcg.api.MenuItem

public abstract class MenuItem
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MenuItem(java.lang.String text) Creates new item, with Paper as the material.
MenuItem(java.lang.String text, org.bukkit.material.MaterialData icon) Adds an item in the first slot.
MenuItem(java.lang.String text, org.bukkit.material.MaterialData icon, int number) Creates a MenuItem.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDescriptions(java.lang.String line) Adds a description to the line.
org.bukkit.material.MaterialData	getIcon() Returns the icon of the item.
Menu	getMenu() Gets the menu
int	getNumber() Gets the number of the item.
java.lang.String	getText() Gets the name of an item.
abstract void	onClick(org.bukkit.entity.Player paramPlayer) Used in MaterialData
void	removeFromMenu(Menu menu) Removes a menu from a menu
void	setDescriptions(java.util.List<java.lang.String> lines) Sets the description.

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuItem

public MenuItem(java.lang.String text)

Creates new item, with Paper as the material. Simple for quickly adding items.

Parameters:

text - Paper Name

MenuItem

public MenuItem(java.lang.String text,
        org.bukkit.material.MaterialData icon)

Adds an item in the first slot.

Parameters:

text - Item Name

icon - MaterialData

MenuItem

public MenuItem(java.lang.String text,
        org.bukkit.material.MaterialData icon,
        int number)

Creates a MenuItem. Derived from MenuAPI

Parameters:

text - Title

icon - MaterialData

number - amount of the item

Method Detail

removeFromMenu

public void removeFromMenu(Menu menu)

Removes a menu from a menu

Parameters:

menu - Menu Object

getMenu

public Menu getMenu()

Gets the menu

Returns:

this.menu

getNumber

public int getNumber()

Gets the number of the item.

Returns:

this.number

getIcon

public org.bukkit.material.MaterialData getIcon()

Returns the icon of the item.

Returns:

this.icon

getText

public java.lang.String getText()

Gets the name of an item.

Returns:

this.text

setDescriptions

public void setDescriptions(java.util.List<java.lang.String> lines)

Sets the description.

Parameters:

lines - The ArrayList 'lines'.

addDescriptions

public void addDescriptions(java.lang.String line)

Adds a description to the line. Use setDescription() to add the lore.

Parameters:

line - Line of lore

onClick

public abstract void onClick(org.bukkit.entity.Player paramPlayer)

Used in MaterialData

Parameters:

paramPlayer - Player