eu.wauz.wauzcore.menu.collection

Class QuestRewardChooser

java.lang.Object

eu.wauz.wauzcore.menu.collection.QuestRewardChooser

All Implemented Interfaces:

WauzInventory

public class QuestRewardChooser
extends java.lang.Object
implements WauzInventory

An inventory that can be used as menu or for other custom interaction mechanics. Lets you choose a reward after completing a quest.

Author:

Wauzmons

See Also:

WauzQuest

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.inventory.Inventory	choiceDialog The inventory instance to hold the selectable choices.
private java.lang.Integer	chosenRewardIndex The index of the chosen reward item stack.
private WauzPlayerEventQuestComplete	completeEvent The complete event to execute.
private WauzQuest	quest The quest that has been completed.

Constructor Summary

Constructors

Constructor and Description
QuestRewardChooser(WauzQuest quest, WauzPlayerEventQuestComplete completeEvent) Creates a new chooser with an event to execute after the choice was made.

Method Summary

Modifier and Type	Method and Description
private static org.bukkit.inventory.ItemStack	generateUnavailableChoiceItem(int itemNumber) Generates an item stack, displaying an unavailable choice.
java.lang.String	getInventoryId()
private static boolean	isRewardChoice(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack is a reward choice, by looking for the prefix.
private static org.bukkit.inventory.ItemStack	makeRewardChoice(org.bukkit.inventory.ItemStack choiceItemStack) Transforms an item stack into a reward choice, by adding a prefix to it.
static void	open(org.bukkit.entity.Player player, WauzQuest quest, WauzPlayerEventQuestComplete completeEvent) Opens the menu for the given player.
void	selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event) Checks if an event in this inventory was triggered by a player click.
void	setChoiceDialog(org.bukkit.inventory.Inventory choiceDialog)
void	updateChoiceSelection() Updates the selection of the reward.

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, getGamemodes, openInstance

Field Detail

quest

private WauzQuest quest

The quest that has been completed.

completeEvent

private WauzPlayerEventQuestComplete completeEvent

The complete event to execute.

choiceDialog

private org.bukkit.inventory.Inventory choiceDialog

The inventory instance to hold the selectable choices.

chosenRewardIndex

private java.lang.Integer chosenRewardIndex

The index of the chosen reward item stack.

Constructor Detail

QuestRewardChooser

public QuestRewardChooser(WauzQuest quest,
                          WauzPlayerEventQuestComplete completeEvent)

Creates a new chooser with an event to execute after the choice was made.

Parameters:

quest - The quest that has been completed.

completeEvent - The complete event to execute.

Method Detail

getInventoryId

public java.lang.String getInventoryId()

Specified by:

getInventoryId in interface WauzInventory

Returns:

The id of the inventory.

open

public static void open(org.bukkit.entity.Player player,
                        WauzQuest quest,
                        WauzPlayerEventQuestComplete completeEvent)

Opens the menu for the given player. Shows the rewards, the player receives for the quest and a confirm button. If a reward item can be chosen, the player must do this before proceeding.

Parameters:

player - The player that should view the inventory.

quest - The quest that has been completed.

completeEvent - The complete event to execute.

generateUnavailableChoiceItem

private static org.bukkit.inventory.ItemStack generateUnavailableChoiceItem(int itemNumber)

Generates an item stack, displaying an unavailable choice.

Parameters:

itemNumber - The number in the title.

Returns:

The choice item stack.

makeRewardChoice

private static org.bukkit.inventory.ItemStack makeRewardChoice(org.bukkit.inventory.ItemStack choiceItemStack)

Transforms an item stack into a reward choice, by adding a prefix to it.

Parameters:

choiceItemStack - The item stack to transform.

Returns:

The transformed item stack;

isRewardChoice

private static boolean isRewardChoice(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack is a reward choice, by looking for the prefix.

Parameters:

itemStack - The item stack to check.

Returns:

If it is a reward choice.

selectMenuPoint

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

Checks if an event in this inventory was triggered by a player click. The default event will be automatically canceled. The quest can be completed, when a reward was selected.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

WauzPlayerEventQuestComplete.execute(Player)

updateChoiceSelection

public void updateChoiceSelection()

Updates the selection of the reward. If no reward is selected, a notice will be added to the complete menu item, also disabling it that way. The selected reward will start to glow, by adding a hidden enchant to it.

setChoiceDialog

public void setChoiceDialog(org.bukkit.inventory.Inventory choiceDialog)

Parameters:

choiceDialog - The new inventory instance to hold the selectable choices.