io.mazenmc.menuapi.menu

Class Menu

java.lang.Object

io.mazenmc.menuapi.menu.Menu

All Implemented Interfaces:

org.bukkit.event.Listener

Direct Known Subclasses:

MultiMenu

public class Menu
extends Object
implements org.bukkit.event.Listener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Menu(String name, int size)

Method Summary

Modifier and Type	Method and Description
static Menu	createMenu(String name, int size)
org.bukkit.inventory.Inventory	inventory() The inventory representation of this menu
Item	itemAt(int index) Returns the item at specified index
Item	itemAt(int x, int z) Returns the item at specified coordinates, where x is on the horizontal axis and z is on the vertical axis.
String	name() The name of this menu, with translated color codes
void	onClick(org.bukkit.event.inventory.InventoryClickEvent event)
void	onDrag(org.bukkit.event.inventory.InventoryDragEvent event)
void	onExit(org.bukkit.event.inventory.InventoryCloseEvent event)
Menu	setItem(int x, int z, Item item) Sets the item at the specified coordinates, where x is on the horizontal axis and z is on the vertical axis.
Menu	setItem(int index, Item item) Sets the item at the specified index
Menu	setParent(Menu parent) Sets the parent of the menu, used when the player exits the menu
void	showTo(org.bukkit.entity.Player... players) Show the menu to the inputted players
int	size() The size of this menu

Methods inherited from class java.lang.Object

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

Constructor Detail

Menu

protected Menu(String name,
               int size)

Method Detail

createMenu

public static Menu createMenu(String name,
                              int size)

name

public String name()

The name of this menu, with translated color codes

Returns:

The name

size

public int size()

The size of this menu

Returns:

The size of this menu

inventory

public org.bukkit.inventory.Inventory inventory()

The inventory representation of this menu

Returns:

The inventory representation

itemAt

public Item itemAt(int index)

Returns the item at specified index

Parameters:

index -

Returns:

Found item

itemAt

public Item itemAt(int x,
                   int z)

Returns the item at specified coordinates, where x is on the horizontal axis and z is on the vertical axis.

Parameters:

x - The x coordinate

z - The z coordinate

Returns:

Found item

setItem

public Menu setItem(int index,
                    Item item)

Sets the item at the specified index

Parameters:

index - Index of the item you wish to set

item - The item you wish to set the index as

setItem

public Menu setItem(int x,
                    int z,
                    Item item)

Sets the item at the specified coordinates, where x is on the horizontal axis and z is on the vertical axis.

Parameters:

x - The x coordinate

z - The z coordinate

item - The item you wish to set the index as

setParent

public Menu setParent(Menu parent)

Sets the parent of the menu, used when the player exits the menu

showTo

public void showTo(org.bukkit.entity.Player... players)

Show the menu to the inputted players

Parameters:

players - The players you wish to show the menu too

onExit

public void onExit(org.bukkit.event.inventory.InventoryCloseEvent event)

onClick

public void onClick(org.bukkit.event.inventory.InventoryClickEvent event)

onDrag

public void onDrag(org.bukkit.event.inventory.InventoryDragEvent event)