Package com.loohp.limbo.inventory

Class InventoryView

java.lang.Object

com.loohp.limbo.inventory.InventoryView

public class InventoryView
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InventoryView.Property	Represents various extra properties of certain inventory windows.
static class	InventoryView.Unsafe	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	OUTSIDE

Constructor Summary

Constructors

Constructor	Description
InventoryView(Player player, net.kyori.adventure.text.Component title, Inventory topInventory, Inventory bottomInventory)

Method Summary

Modifier and Type	Method	Description
void	close()
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	countSlots()	Check the total number of slots in this view, combining the upper and lower inventories.
Inventory	getBottomInventory()
ItemStack	getCarriedItem()
Inventory	getInventory(int rawSlot)	Gets the inventory corresponding to the given raw slot ID.
ItemStack	getItem(int index)
Player	getPlayer()
Map<InventoryView.Property,Integer>	getProperties()
InventoryType.SlotType	getSlotType(int slot)	Determine the type of the slot by its raw slot ID.
net.kyori.adventure.text.Component	getTitle()
Inventory	getTopInventory()
InventoryType	getType()
InventoryView.Unsafe	getUnsafe()	Deprecated.
boolean	isSlot(int index)
void	setCarriedItem(ItemStack carriedItem)
void	setItem(int index, ItemStack itemStack)
void	setProperty(InventoryView.Property prop, int value)
void	updateView()

Methods inherited from class java.lang.Object

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

Field Details

OUTSIDE

public static final int OUTSIDE

See Also:

• Constant Field Values

Constructor Details

InventoryView

public InventoryView(Player player,
 net.kyori.adventure.text.Component title,
 Inventory topInventory,
 Inventory bottomInventory)

Method Details

getCarriedItem

public ItemStack getCarriedItem()

setCarriedItem

public void setCarriedItem(ItemStack carriedItem)

getType

public InventoryType getType()

getPlayer

public Player getPlayer()

getTitle

public net.kyori.adventure.text.Component getTitle()

getTopInventory

public Inventory getTopInventory()

getBottomInventory

public Inventory getBottomInventory()

getProperties

public Map<InventoryView.Property,Integer> getProperties()

getInventory

public Inventory getInventory(int rawSlot)

Gets the inventory corresponding to the given raw slot ID. If the slot ID is OUTSIDE null will be returned, otherwise behaviour for illegal and negative slot IDs is undefined. May be used with convertSlot(int) to directly index an underlying inventory.

Parameters:

rawSlot - The raw slot ID.

Returns:

corresponding inventory, or null

convertSlot

public 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

public InventoryType.SlotType getSlotType(int slot)

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

countSlots

public 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

close

public void close()

isSlot

public boolean isSlot(int index)

getItem

public ItemStack getItem(int index)

setItem

public void setItem(int index,
 ItemStack itemStack)

setProperty

public void setProperty(InventoryView.Property prop,
 int value)

updateView

public void updateView()

getUnsafe

@Deprecated
public InventoryView.Unsafe getUnsafe()

Deprecated.