com.codelanx.codelanxlib.inventory

Class Inventories

java.lang.Object

com.codelanx.codelanxlib.inventory.Inventories

public final class Inventories
extends Object

Utility methods for simplifying the use of Bukkit's inventory API, or providing methods that can accomplish tasks that have obscure or complicated solutions.

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static Integer[]	findPlacement(Item item, Inventory inv) Returns the slot(s) that an Item would be placed into.
static int	getHeldItemSlot(Player p) Returns the inventory slot for the item in a Player's hand.
static boolean	hasClickedTop(InventoryClickEvent event) Returns whether or not the player clicked the top or bottom inventory

Methods inherited from class java.lang.Object

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

Method Detail

hasClickedTop

public static boolean hasClickedTop(InventoryClickEvent event)

Returns whether or not the player clicked the top or bottom inventory

Parameters:

event - The relevant InventoryClickEvent

Returns:

true for clicking the top, false otherwise

Since:

0.0.1

getHeldItemSlot

public static int getHeldItemSlot(Player p)

Returns the inventory slot for the item in a Player's hand.

Parameters:

p - The player to get the item slot from

Returns:

The non-raw slot number of the item being held

Throws:

IllegalStateException - if the item is modified during the method execution

Since:

0.1.0

findPlacement

public static Integer[] findPlacement(Item item,
                                      Inventory inv)

Returns the slot(s) that an Item would be placed into.

Parameters:

item - The Item being placed into an Inventory

inv - The Inventory being placed into

Returns:

The slot(s) that would be affected by this placement

Since:

0.1.0