eu.wauz.wauzcore.menu.social

Class TabardBuilder

java.lang.Object

eu.wauz.wauzcore.menu.social.TabardBuilder

All Implemented Interfaces:

WauzInventory

public class TabardBuilder
extends java.lang.Object
implements WauzInventory

An inventory that can be used as menu or for other custom interaction mechanics. This inventory lets a player create a tabard / banner for their guild.

Author:

Wauzmons

See Also:

TabardMenu

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	guildUuidString The uuid of the guild that owns the tabard.
private int	layers The amount of layers the tabard / banner has.
private java.lang.String	page The name of the current editing page view.
private org.bukkit.inventory.ItemStack	tabard The tabard / banner item stack that is getting edited.

Constructor Summary

Constructors

Constructor and Description
TabardBuilder() Creates an empty tabard builder.
TabardBuilder(org.bukkit.inventory.ItemStack tabard, java.lang.String guildUuidString) Creates a new tabard builder for the given guild.

Method Summary

Modifier and Type	Method and Description
java.util.List<WauzMode>	getGamemodes()
java.lang.String	getGuildUuidString()
java.lang.String	getInventoryId()
int	getLayers()
org.bukkit.inventory.ItemStack	getTabard()
static void	open(org.bukkit.entity.Player player) Opens the menu for the given player.
static void	open(org.bukkit.entity.Player player, TabardBuilder tabardBuilder) Opens the menu for the given player.
void	openColorSelection(org.bukkit.entity.Player player) Shows a view of all selectable base or layer colors for the tabard / banner.
void	openInstance(org.bukkit.entity.Player player) Opens a new inventory of this type for the given player.
void	openPatternSelection(org.bukkit.entity.Player player, org.bukkit.DyeColor color) Shows a view of all selectable layer patterns in the given dye color.
void	selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event) Checks if an event in this inventory was triggered by a player click.
void	setGuildUuidString(java.lang.String guildUuidString)
void	setTabard(org.bukkit.inventory.ItemStack tabard)

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.wauz.wauzcore.menu.util.WauzInventory

destroyInventory

Field Detail

tabard

private org.bukkit.inventory.ItemStack tabard

The tabard / banner item stack that is getting edited.

guildUuidString

private java.lang.String guildUuidString

The uuid of the guild that owns the tabard.

page

private java.lang.String page

The name of the current editing page view.

layers

private int layers

The amount of layers the tabard / banner has.

Constructor Detail

TabardBuilder

public TabardBuilder()

Creates an empty tabard builder.

TabardBuilder

public TabardBuilder(org.bukkit.inventory.ItemStack tabard,
                     java.lang.String guildUuidString)

Creates a new tabard builder for the given guild.

Parameters:

tabard - The initial tabard / banner item stack that is getting edited.

guildUuidString - The uuid of the guild that owns the tabard.

Method Detail

getInventoryId

public java.lang.String getInventoryId()

Specified by:

getInventoryId in interface WauzInventory

Returns:

The id of the inventory.

getGamemodes

public java.util.List<WauzMode> getGamemodes()

Specified by:

getGamemodes in interface WauzInventory

Returns:

The modes in which the inventory can be opened.

openInstance

public void openInstance(org.bukkit.entity.Player player)

Opens a new inventory of this type for the given player.

Specified by:

openInstance in interface WauzInventory

Parameters:

player - The player that should view the inventory.

open

public static void open(org.bukkit.entity.Player player)

Opens the menu for the given player. Used for the initial opening, where a new tabard builder is initialized and the real editing menu is loaded. Only openable if the player is a guild officer or higher.

Parameters:

player - The player that should view the inventory.

See Also:

GuildOverviewMenu.validateOfficerAccess(Player, WauzPlayerGuild), TabardBuilder(ItemStack, String), open(Player, TabardBuilder)

open

public static void open(org.bukkit.entity.Player player,
                        TabardBuilder tabardBuilder)

Opens the menu for the given player. Shows the tabard that is being edited, aswell as options to change the base color or add a new layer. The tabard can also be saved or discarded from this menu.

Parameters:

player - The player that should view the inventory.

tabardBuilder - The active tabard builder.

See Also:

getTabard(), MenuUtils.setBorders(Inventory)

getTabard

public org.bukkit.inventory.ItemStack getTabard()

Returns:

The tabard / banner item stack that is getting edited.

setTabard

public void setTabard(org.bukkit.inventory.ItemStack tabard)

Parameters:

tabard - The new tabard / banner item stack that is getting edited.

getGuildUuidString

public java.lang.String getGuildUuidString()

Returns:

The uuid of the guild that owns the tabard.

setGuildUuidString

public void setGuildUuidString(java.lang.String guildUuidString)

Parameters:

guildUuidString - The new uuid of the guild that owns the tabard.

getLayers

public int getLayers()

Returns:

The amount of layers the tabard / banner has.

selectMenuPoint

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

Checks if an event in this inventory was triggered by a player click. Cancels the event and opens the selected view or executes the editing action. Possible actions are determined through the view name. From the overview a new layer can be added, the base color can be changed, or the tabard can be saved or declined. From the base color selection, the new color can be directly loaded into the tabard. From the layer color selection, the layer pattern selection can be viewed with the selected color. From the layer pattern selection, the colored layer can be directly added to the tabard.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

open(Player, TabardBuilder), openColorSelection(Player), openPatternSelection(Player, DyeColor), GuildConfigurator.setGuildTabard(String, ItemStack), GuildOverviewMenu.open(Player)

openColorSelection

public void openColorSelection(org.bukkit.entity.Player player)

Shows a view of all selectable base or layer colors for the tabard / banner.

Parameters:

player - The player that should view the inventory.

See Also:

MenuUtils.setBorders(Inventory)

openPatternSelection

public void openPatternSelection(org.bukkit.entity.Player player,
                                 org.bukkit.DyeColor color)

Shows a view of all selectable layer patterns in the given dye color.

Parameters:

player - The player that should view the inventory.

color - The color to show the patterns in.

See Also:

MenuUtils.setBorders(Inventory)