com.github.ms5984.api.menuman

Class MenuElement

java.lang.Object

com.github.ms5984.api.menuman.MenuElement

public final class MenuElement
extends Object

Encapsulation to promote lazy-initialization of ItemStacks

Field Summary

Fields

Modifier and Type	Field and Description
protected org.bukkit.inventory.ItemStack	baseItem Initial ItemStack.
protected String	displayName A custom title for the final ItemStack.
protected List<String>	lore A custom description for the ItemStack.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MenuElement(org.bukkit.inventory.ItemStack baseItem) Specify MenuElement with no initial styling.
protected	MenuElement(org.bukkit.inventory.ItemStack baseItem, String text, String... lore) Specify MenuElement with preconfigured styling.

Method Summary

Modifier and Type	Method and Description
org.bukkit.inventory.ItemStack	generateComplete() Generate the final ItemStack, styled if needed.

Methods inherited from class java.lang.Object

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

Field Detail

baseItem

protected org.bukkit.inventory.ItemStack baseItem

Initial ItemStack. May or may not be styled.

displayName

protected String displayName

A custom title for the final ItemStack.

lore

protected List<String> lore

A custom description for the ItemStack.

Constructor Detail

MenuElement

protected MenuElement(org.bukkit.inventory.ItemStack baseItem)

Specify MenuElement with no initial styling.

Parameters:

baseItem - ItemStack to copy

MenuElement

protected MenuElement(org.bukkit.inventory.ItemStack baseItem,
                      String text,
                      String... lore)

Specify MenuElement with preconfigured styling.

Parameters:

baseItem - ItemStack to copy

text - custom text

lore - custom lore

Method Detail

generateComplete

public org.bukkit.inventory.ItemStack generateComplete()

Generate the final ItemStack, styled if needed.

Returns:

generated ItemStack