public interface Chest
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.Integer,org.bukkit.inventory.ItemStack> |
addItems(org.bukkit.inventory.ItemStack... itemStacks)
Add items to the chest.
|
java.util.Map<java.lang.Integer,org.bukkit.inventory.ItemStack> |
addRawItems(org.bukkit.inventory.ItemStack... itemStacks)
Deprecated.
use addItems(ItemStack... itemStacks)
|
boolean |
canPlaceItemThroughFace(org.bukkit.inventory.ItemStack itemStack)
Check if hoppers can move items into the chest.
|
boolean |
canTakeItemThroughFace(int slot,
org.bukkit.inventory.ItemStack itemStack)
Check if hoppers can take items in a specific slot.
|
void |
closePage(org.bukkit.entity.Player player)
Handle the close of a page.
|
ChestType |
getChestType()
Get the type of the chest.
|
org.bukkit.inventory.ItemStack[] |
getContents()
Get all the contents of the chest.
|
ChestData |
getData()
Get the settings object of the chest.
|
org.bukkit.inventory.ItemStack |
getItem(int slot)
Get an item from the chest in a specific slot.
|
org.bukkit.Location |
getLocation()
Get the location of the chest.
|
org.bukkit.inventory.Inventory |
getPage(int page)
Get a specific page of this chest.
|
int |
getPageIndex(org.bukkit.inventory.Inventory inventory)
Get the index of a page.
|
org.bukkit.inventory.Inventory[] |
getPages()
Get all the pages of this chest.
|
int |
getPagesAmount()
Get the amount of pages for this chest.
|
java.util.UUID |
getPlacer()
Get the uuid of the player that placed the chest.
|
int[] |
getSlotsForFace()
Get a list of slots that will be checked for hopper interactions.
|
boolean |
onBreak(org.bukkit.event.block.BlockBreakEvent event)
Handle the break of the chest.
|
boolean |
onClose(org.bukkit.event.inventory.InventoryCloseEvent event)
Handle closing the chest.
|
boolean |
onHopperItemTake(org.bukkit.inventory.Inventory hopperInventory)
Deprecated.
Not used in v2.0.0 anymore.
|
boolean |
onHopperMove(org.bukkit.event.inventory.InventoryMoveItemEvent event)
Deprecated.
Not used in v2.0.0 anymore.
|
boolean |
onHopperMove(org.bukkit.inventory.ItemStack itemStack,
org.bukkit.block.Hopper hopper)
Deprecated.
Not used in v2.0.0 anymore.
|
boolean |
onInteract(org.bukkit.event.inventory.InventoryClickEvent event)
Handle item interactions in the chest.
|
boolean |
onOpen(org.bukkit.event.player.PlayerInteractEvent event)
Handle opening the chest.
|
boolean |
onPlace(org.bukkit.event.block.BlockPlaceEvent event)
Deprecated.
Not used in v2.0.0 anymore.
|
void |
openPage(org.bukkit.entity.Player player,
int page)
Open a page for a player.
|
void |
remove()
Remove the chest from the database & cache.
|
void |
removeItem(int amountToRemove,
org.bukkit.inventory.ItemStack itemStack)
Remove an item from the chest.
|
void |
setItem(int slot,
org.bukkit.inventory.ItemStack itemStack)
Set an item in the chest in a specific slot.
|
org.bukkit.inventory.Inventory |
setPage(int page,
int size,
java.lang.String title)
Set a page with a specific size and title.
|
void |
setPage(int page,
org.bukkit.inventory.Inventory inventory)
Deprecated.
You should use setPage(int page, int size, String title), and then change the contents manually.
|
java.util.UUID getPlacer()
org.bukkit.Location getLocation()
ChestData getData()
ChestType getChestType()
void remove()
org.bukkit.inventory.ItemStack[] getContents()
java.util.Map<java.lang.Integer,org.bukkit.inventory.ItemStack> addItems(org.bukkit.inventory.ItemStack... itemStacks)
itemStacks
- The items to add@Deprecated java.util.Map<java.lang.Integer,org.bukkit.inventory.ItemStack> addRawItems(org.bukkit.inventory.ItemStack... itemStacks)
itemStacks
- The items to addvoid removeItem(int amountToRemove, org.bukkit.inventory.ItemStack itemStack)
amountToRemove
- The amount to remove from the item.itemStack
- The item to remove.org.bukkit.inventory.ItemStack getItem(int slot)
slot
- The slot of the item. Can support all the pages using the following formula:
slot = (page-index) * (pages-size) + (page-slot)void setItem(int slot, org.bukkit.inventory.ItemStack itemStack)
slot
- The slot of the item. Can support all the pages using the following formula:
slot = (page-index) * (pages-size) + (page-slot)itemStack
- The item to set.org.bukkit.inventory.Inventory getPage(int page)
page
- The page index to get.
The index should between 0 and getPagesAmount() return value.org.bukkit.inventory.Inventory[] getPages()
@Deprecated void setPage(int page, org.bukkit.inventory.Inventory inventory)
page
- The page's index. Should between 0 and getPagesAmount() return value.inventory
- The inventory to change the contents to.org.bukkit.inventory.Inventory setPage(int page, int size, java.lang.String title)
page
- The page's index. Should between 0 and getPagesAmount() return value.size
- The size of the page. Should be between 9 and 54.title
- The title of the page.void openPage(org.bukkit.entity.Player player, int page)
player
- The player to open the page forpage
- The page to open. Should between 0 and getPagesAmount() return value.void closePage(org.bukkit.entity.Player player)
player
- The player to close the page for.int getPagesAmount()
int getPageIndex(org.bukkit.inventory.Inventory inventory)
inventory
- The page's inventory.boolean onBreak(org.bukkit.event.block.BlockBreakEvent event)
event
- The BlockBreakEvent that was fired.@Deprecated boolean onPlace(org.bukkit.event.block.BlockPlaceEvent event)
event
- The BlockPlaceEvent that was fired.boolean onOpen(org.bukkit.event.player.PlayerInteractEvent event)
event
- The PlayerInteractEvent that was fired.boolean onClose(org.bukkit.event.inventory.InventoryCloseEvent event)
event
- The InventoryCloseEvent that was fired.boolean onInteract(org.bukkit.event.inventory.InventoryClickEvent event)
event
- The InventoryClickEvent that was fired.@Deprecated boolean onHopperMove(org.bukkit.event.inventory.InventoryMoveItemEvent event)
event
- The InventoryMoveItemEvent that was fired.@Deprecated boolean onHopperMove(org.bukkit.inventory.ItemStack itemStack, org.bukkit.block.Hopper hopper)
itemStack
- The item that was moved into.hopper
- The hopper that added the item.@Deprecated boolean onHopperItemTake(org.bukkit.inventory.Inventory hopperInventory)
hopperInventory
- The inventory of the hopper that took the items.boolean canTakeItemThroughFace(int slot, org.bukkit.inventory.ItemStack itemStack)
slot
- The slot of the item.itemStack
- The item to take.int[] getSlotsForFace()
boolean canPlaceItemThroughFace(org.bukkit.inventory.ItemStack itemStack)
itemStack
- The item to add.