eu.wauz.wauzcore.menu

Class TradeMenu

java.lang.Object

eu.wauz.wauzcore.menu.TradeMenu

All Implemented Interfaces:

WauzInventory

public class TradeMenu
extends java.lang.Object
implements WauzInventory

An inventory that can be used as menu or for other custom interaction mechanics. Lets two players trade witch each other.

Author:

Eddshine

See Also:

WauzPlayerTrade

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.entity.Player	leftPlayer The player on the left side of the trade menu.
private boolean	leftPlayerReady The ready status of the player on the left side of the trade menu.
private static java.util.List<java.lang.Integer>	leftSlots Item slots on the left side of the trade menu.
private org.bukkit.inventory.Inventory	menu The trade menu inventory.
private org.bukkit.entity.Player	rightPlayer The player on the right side of the trade menu.
private boolean	rightPlayerReady The ready status of the player on the right side of the trade menu.
private static java.util.List<java.lang.Integer>	rightSlots Item slots on the right side of the trade menu.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TradeMenu(org.bukkit.entity.Player leftPlayer, org.bukkit.entity.Player rightPlayer) Creates a new trade menu instance.

Method Summary

Modifier and Type	Method and Description
void	destroyInventory(org.bukkit.event.inventory.InventoryCloseEvent event) Cleans up everything, so the inventory can be closed.
private void	fillItemList(java.util.List<org.bukkit.inventory.ItemStack> itemList, java.util.List<java.lang.Integer> itemIndexes) Fills the given list with the item stacks from the given menu slots.
java.lang.String	getInventoryId()
private void	handOutItems(boolean ownItemsBack) Hands out the traded items to the players.
static void	open(org.bukkit.entity.Player requestingPlayer, org.bukkit.entity.Player requestedPlayer) Opens the menu for the given players.
void	selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event) Checks if an event in this inventory was triggered by a player click.
void	setMenuInventory(org.bukkit.inventory.Inventory menu) Sets the inventory for the trade menu.
void	setReadyStatus(boolean leftSide, boolean isReady) Sets the ready status of one side of the trade menu.

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

getGamemodes, openInstance

Field Detail

leftSlots

private static java.util.List<java.lang.Integer> leftSlots

Item slots on the left side of the trade menu.

rightSlots

private static java.util.List<java.lang.Integer> rightSlots

Item slots on the right side of the trade menu.

menu

private org.bukkit.inventory.Inventory menu

The trade menu inventory.

leftPlayer

private final org.bukkit.entity.Player leftPlayer

The player on the left side of the trade menu.

rightPlayer

private final org.bukkit.entity.Player rightPlayer

The player on the right side of the trade menu.

leftPlayerReady

private boolean leftPlayerReady

The ready status of the player on the left side of the trade menu.

rightPlayerReady

private boolean rightPlayerReady

The ready status of the player on the right side of the trade menu.

Constructor Detail

TradeMenu

private TradeMenu(org.bukkit.entity.Player leftPlayer,
                  org.bukkit.entity.Player rightPlayer)

Creates a new trade menu instance.

Parameters:

leftPlayer - The player on the left side of the trade menu.

rightPlayer - The player on the right side of the trade menu.

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 requestingPlayer,
                        org.bukkit.entity.Player requestedPlayer)

Opens the menu for the given players. The players can put items on their side of the window. If one player is ready items cannot be changed anymore. If both players are ready the items will be traded. When cancel is clicked, both receive their items back.

Parameters:

requestingPlayer - The player on the left side of the trade menu.

requestedPlayer - The player on the right side of the trade menu.

See Also:

setMenuInventory(Inventory), setReadyStatus(boolean, boolean), MenuUtils.setBorders(Inventory)

setMenuInventory

public void setMenuInventory(org.bukkit.inventory.Inventory menu)

Sets the inventory for the trade menu.

Parameters:

menu - The new trade menu inventory.

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. Players can move items in their own inventories and on their menu side. The ready status can be changed or the trade can be cancelled.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

setReadyStatus(boolean, boolean)

destroyInventory

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

Cleans up everything, so the inventory can be closed. The player's will be notified, that the trade ended and will receive their items.

Specified by:

destroyInventory in interface WauzInventory

Parameters:

event - The inventory close event.

See Also:

handOutItems(boolean)

setReadyStatus

public void setReadyStatus(boolean leftSide,
                           boolean isReady)

Sets the ready status of one side of the trade menu. When both players are ready the trade will be executed.

Parameters:

leftSide - If the status of the left side should be set. Else it will be the right side.

isReady - If the given side is ready.

See Also:

handOutItems(boolean)

handOutItems

private void handOutItems(boolean ownItemsBack)

Hands out the traded items to the players.

Parameters:

ownItemsBack - If the players should receive their own items back, instead of the traded ones.

See Also:

fillItemList(List, List), LootContainer.open(Player, List)

fillItemList

private void fillItemList(java.util.List<org.bukkit.inventory.ItemStack> itemList,
                          java.util.List<java.lang.Integer> itemIndexes)

Fills the given list with the item stacks from the given menu slots.

Parameters:

itemList - The list that should be filled.

itemIndexes - The indexes of the menu slots.