Package org.bukkit.inventory

Interface MenuType

All Superinterfaces:

FeatureDependant, Keyed, Keyed

All Known Subinterfaces:

MenuType.Typed<V,B>

@NullMarked
@Experimental
public interface MenuType
extends Keyed, FeatureDependant

Represents different kinds of views, also known as menus, which can be created and viewed by the player.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MenuType.Typed<V extends InventoryView,B extends InventoryViewBuilder<V>>	Typed represents a subtype of MenuTypes that have a known InventoryView type at compile time.

Field Summary

Fields

Modifier and Type	Field	Description
static final MenuType.Typed<AnvilView,LocationInventoryViewBuilder<AnvilView>>	ANVIL	A MenuType which represents an anvil.
static final MenuType.Typed<BeaconView,LocationInventoryViewBuilder<BeaconView>>	BEACON	A MenuType which represents a beacon.
static final MenuType.Typed<FurnaceView,LocationInventoryViewBuilder<FurnaceView>>	BLAST_FURNACE	A MenuType which represents a blast furnace.
static final MenuType.Typed<BrewingStandView,LocationInventoryViewBuilder<BrewingStandView>>	BREWING_STAND	A MenuType which represents a brewing stand.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	CARTOGRAPHY_TABLE	A MenuType which represents a cartography table.
static final MenuType.Typed<CrafterView,LocationInventoryViewBuilder<CrafterView>>	CRAFTER_3X3	A MenuType which represents a crafter
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	CRAFTING	A MenuType which represents a crafting table.
static final MenuType.Typed<EnchantmentView,LocationInventoryViewBuilder<EnchantmentView>>	ENCHANTMENT	A MenuType which represents an enchantment table.
static final MenuType.Typed<FurnaceView,LocationInventoryViewBuilder<FurnaceView>>	FURNACE	A MenuType which represents a furnace.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	GENERIC_3X3	A MenuType which represents a dispenser/dropper like menu with 3 columns and 3 rows.
static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>>	GENERIC_9X1	A MenuType which represents a chest with 1 row.
static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>>	GENERIC_9X2	A MenuType which represents a chest with 2 rows.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	GENERIC_9X3	A MenuType which represents a chest with 3 rows.
static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>>	GENERIC_9X4	A MenuType which represents a chest with 4 rows.
static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>>	GENERIC_9X5	A MenuType which represents a chest with 5 rows.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	GENERIC_9X6	A MenuType which represents a chest with 6 rows.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	GRINDSTONE	A MenuType which represents a grindstone.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	HOPPER	A MenuType which represents a hopper.
static final MenuType.Typed<LecternView,LocationInventoryViewBuilder<LecternView>>	LECTERN	A MenuType which represents a lectern, a book like view.
static final MenuType.Typed<LoomView,LocationInventoryViewBuilder<LoomView>>	LOOM	A MenuType which represents a loom.
static final MenuType.Typed<MerchantView,MerchantInventoryViewBuilder<MerchantView>>	MERCHANT	A MenuType which represents a merchant.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	SHULKER_BOX	A MenuType which represents a shulker box.
static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>>	SMITHING	A MenuType which represents a smithing table.
static final MenuType.Typed<FurnaceView,LocationInventoryViewBuilder<FurnaceView>>	SMOKER	A MenuType which represents a smoker.
static final MenuType.Typed<StonecutterView,LocationInventoryViewBuilder<StonecutterView>>	STONECUTTER	A MenuType which represents a stonecutter.

Method Summary

Modifier and Type	Method	Description
InventoryView	create(HumanEntity player, @Nullable Component title)	Creates a view of the specified menu type.
Class<? extends InventoryView>	getInventoryViewClass()	Gets the InventoryView class of this MenuType.
MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>>	typed()	Yields this MenuType as a typed version of itself with a plain InventoryView representing it.
<V extends InventoryView, B extends InventoryViewBuilder<V>> MenuType.Typed<V,B>	typed(Class<V> viewClass)	Yields this MenuType as a typed version of itself with a specific InventoryView representing it.

Methods inherited from interface io.papermc.paper.world.flag.FeatureDependant

requiredFeatures

Methods inherited from interface org.bukkit.Keyed

getKey, key

Field Details

GENERIC_9X1

static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>> GENERIC_9X1

A MenuType which represents a chest with 1 row.

GENERIC_9X2

static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>> GENERIC_9X2

A MenuType which represents a chest with 2 rows.

GENERIC_9X3

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> GENERIC_9X3

A MenuType which represents a chest with 3 rows.

GENERIC_9X4

static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>> GENERIC_9X4

A MenuType which represents a chest with 4 rows.

GENERIC_9X5

static final MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>> GENERIC_9X5

A MenuType which represents a chest with 5 rows.

GENERIC_9X6

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> GENERIC_9X6

A MenuType which represents a chest with 6 rows.

GENERIC_3X3

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> GENERIC_3X3

A MenuType which represents a dispenser/dropper like menu with 3 columns and 3 rows.

CRAFTER_3X3

static final MenuType.Typed<CrafterView,LocationInventoryViewBuilder<CrafterView>> CRAFTER_3X3

A MenuType which represents a crafter

ANVIL

static final MenuType.Typed<AnvilView,LocationInventoryViewBuilder<AnvilView>> ANVIL

A MenuType which represents an anvil.

BEACON

static final MenuType.Typed<BeaconView,LocationInventoryViewBuilder<BeaconView>> BEACON

A MenuType which represents a beacon.

BLAST_FURNACE

static final MenuType.Typed<FurnaceView,LocationInventoryViewBuilder<FurnaceView>> BLAST_FURNACE

A MenuType which represents a blast furnace.

BREWING_STAND

static final MenuType.Typed<BrewingStandView,LocationInventoryViewBuilder<BrewingStandView>> BREWING_STAND

A MenuType which represents a brewing stand.

CRAFTING

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> CRAFTING

A MenuType which represents a crafting table.

ENCHANTMENT

static final MenuType.Typed<EnchantmentView,LocationInventoryViewBuilder<EnchantmentView>> ENCHANTMENT

A MenuType which represents an enchantment table.

FURNACE

static final MenuType.Typed<FurnaceView,LocationInventoryViewBuilder<FurnaceView>> FURNACE

A MenuType which represents a furnace.

GRINDSTONE

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> GRINDSTONE

A MenuType which represents a grindstone.

HOPPER

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> HOPPER

A MenuType which represents a hopper.

LECTERN

static final MenuType.Typed<LecternView,LocationInventoryViewBuilder<LecternView>> LECTERN

A MenuType which represents a lectern, a book like view.

LOOM

static final MenuType.Typed<LoomView,LocationInventoryViewBuilder<LoomView>> LOOM

A MenuType which represents a loom.

MERCHANT

static final MenuType.Typed<MerchantView,MerchantInventoryViewBuilder<MerchantView>> MERCHANT

A MenuType which represents a merchant.

SHULKER_BOX

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> SHULKER_BOX

A MenuType which represents a shulker box.

SMITHING

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> SMITHING

A MenuType which represents a smithing table.

SMOKER

static final MenuType.Typed<FurnaceView,LocationInventoryViewBuilder<FurnaceView>> SMOKER

A MenuType which represents a smoker.

CARTOGRAPHY_TABLE

static final MenuType.Typed<InventoryView,LocationInventoryViewBuilder<InventoryView>> CARTOGRAPHY_TABLE

A MenuType which represents a cartography table.

STONECUTTER

static final MenuType.Typed<StonecutterView,LocationInventoryViewBuilder<StonecutterView>> STONECUTTER

A MenuType which represents a stonecutter.

Method Details

create

InventoryView create(HumanEntity player,
 @Nullable Component title)

Creates a view of the specified menu type.

The player provided to create this view must be the player the view is opened for. See HumanEntity.openInventory(InventoryView) for more information.

Parameters:

player - the player the view belongs to

title - the title of the view

Returns:

the created InventoryView

typed

MenuType.Typed<InventoryView,InventoryViewBuilder<InventoryView>> typed()

Yields this MenuType as a typed version of itself with a plain InventoryView representing it.

Returns:

the typed MenuType.

typed

<V extends InventoryView,
B extends InventoryViewBuilder<V>>
MenuType.Typed<V,B> typed(Class<V> viewClass)
                   throws IllegalArgumentException

Yields this MenuType as a typed version of itself with a specific InventoryView representing it.

Type Parameters:

V - the generic type of the InventoryView to get this MenuType with

B - the generic type of the InventoryViewBuilder to get this MenuType with

Parameters:

viewClass - the class type of the InventoryView to type this InventoryView with.

Returns:

the typed MenuType

Throws:

IllegalArgumentException - if the provided viewClass cannot be typed to this MenuType

getInventoryViewClass

Class<? extends InventoryView> getInventoryViewClass()

Gets the InventoryView class of this MenuType.

Returns:

the InventoryView class of this MenuType