Interface InventoryView
- All Known Subinterfaces:
AnvilView
,BeaconView
,BrewingStandView
,CrafterView
,EnchantmentView
,FurnaceView
,LecternView
,LoomView
,MerchantView
,StonecutterView
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
Deprecated, for removal: This API element is subject to removal in a future version. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the inventory view.int
convertSlot
(int rawSlot) Converts a raw slot ID into its local slot ID into whichever of the two inventories the slot points to.int
Check the total number of slots in this view, combining the upper and lower inventories.Get the lower inventory involved in this transaction.Get the item on the cursor of one of the viewing players.getInventory
(int rawSlot) Gets the inventory corresponding to the given raw slot ID.getItem
(int slot) Gets one item in this inventory view by its raw slot ID.Deprecated.changing the title is not supportedGet the player viewing.getSlotType
(int slot) Determine the type of the slot by its raw slot ID.getTitle()
Deprecated.in favour oftitle()
Get the upper inventory involved in this transaction.getType()
Determine the type of inventory involved in the transaction.void
Sets the item on the cursor of one of the viewing players.void
Sets one item in this inventory view by its raw slot ID.boolean
setProperty
(@NotNull InventoryView.Property prop, int value) Sets an extra property of this inventory if supported by that inventory, for example the state of a progress bar.void
Deprecated.changing the title is not supported.default Component
title()
Get the title of this inventory window.
-
Field Details
-
OUTSIDE
static final int OUTSIDE- See Also:
-
-
Method Details
-
getTopInventory
Get the upper inventory involved in this transaction.- Returns:
- the inventory
-
getBottomInventory
Get the lower inventory involved in this transaction.- Returns:
- the inventory
-
getPlayer
Get the player viewing.- Returns:
- the player
-
getType
Determine the type of inventory involved in the transaction. This indicates the window style being shown. It will never return PLAYER, since that is common to all windows.- Returns:
- the inventory type
-
setItem
Sets one item in this inventory view by its raw slot ID.Note: If slot ID -999 is chosen, it may be expected that the item is dropped on the ground. This is not required behaviour, however.
- Parameters:
slot
- The ID as returned by InventoryClickEvent.getRawSlot()item
- The new item to put in the slot, or null to clear it.
-
getItem
Gets one item in this inventory view by its raw slot ID.- Parameters:
slot
- The ID as returned by InventoryClickEvent.getRawSlot()- Returns:
- The item currently in the slot.
-
setCursor
Sets the item on the cursor of one of the viewing players.- Parameters:
item
- The item to put on the cursor, or null to remove the item on their cursor.
-
getCursor
Get the item on the cursor of one of the viewing players.- Returns:
- The item on the player's cursor, or an empty stack if they aren't holding one.
-
getInventory
Gets the inventory corresponding to the given raw slot ID. If the slot ID isOUTSIDE
null will be returned, otherwise behaviour for illegal and negative slot IDs is undefined. May be used withconvertSlot(int)
to directly index an underlying inventory.- Parameters:
rawSlot
- The raw slot ID.- Returns:
- corresponding inventory, or null
-
convertSlot
int convertSlot(int rawSlot) Converts a raw slot ID into its local slot ID into whichever of the two inventories the slot points to.If the raw slot refers to the upper inventory, it will be returned unchanged and thus be suitable for getTopInventory().getItem(); if it refers to the lower inventory, the output will differ from the input and be suitable for getBottomInventory().getItem().
- Parameters:
rawSlot
- The raw slot ID.- Returns:
- The converted slot ID.
-
getSlotType
Determine the type of the slot by its raw slot ID.If the type of the slot is unknown, then
InventoryType.SlotType.CONTAINER
will be returned.- Parameters:
slot
- The raw slot ID- Returns:
- the slot type
-
close
void close()Closes the inventory view. -
countSlots
int countSlots()Check the total number of slots in this view, combining the upper and lower inventories.Note though that it's possible for this to be greater than the sum of the two inventories if for example some slots are not being used.
- Returns:
- The total size
-
setProperty
Sets an extra property of this inventory if supported by that inventory, for example the state of a progress bar.- Parameters:
prop
- the window property to updatevalue
- the new value for the window property- Returns:
- true if the property was updated successfully, false if the property is not supported by that inventory
-
title
Get the title of this inventory window.- Returns:
- The title.
-
getTitle
Deprecated.in favour oftitle()
Get the title of this inventory window.- Returns:
- The title.
-
getOriginalTitle
Deprecated.changing the title is not supportedGet the original title of this inventory window, before any changes were made usingsetTitle(String)
.- Returns:
- the original title
-
setTitle
Deprecated.changing the title is not supported. This method has poorly defined and broken behaviors. It should not be used.Sets the title of this inventory window to the specified title if the inventory window supports it.Note if the inventory does not support titles that can be changed (ie, it is not creatable or viewed by a player), then this method will throw an exception.
- Parameters:
title
- The new title.
-
InventoryView
and its children