| Package | Description | 
|---|---|
| com.destroystokyo.paper.event.player | |
| io.papermc.paper.event.block | |
| io.papermc.paper.event.entity | |
| io.papermc.paper.event.player | |
| org.bukkit | 
 The root package of the Bukkit API, contains generalized API classes. 
 | 
| org.bukkit.attribute | 
 Classes relevant to attributes. 
 | 
| org.bukkit.enchantments | 
 Classes relating to the specialized enhancements to  
item stacks, as part of the meta data. | 
| org.bukkit.entity | 
 Interfaces for non-voxel objects that can exist in a  
world, including all players, monsters, projectiles, etc. | 
| org.bukkit.event.block | |
| org.bukkit.event.entity | |
| org.bukkit.event.player | |
| org.bukkit.inventory | 
 Classes involved in manipulating player inventories and item interactions. 
 | 
| org.bukkit.inventory.meta | 
 The interfaces used when manipulating extra data can can be stored inside
  
item stacks. | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
PlayerUseUnknownEntityEvent.getHand()  | 
| Constructor and Description | 
|---|
PlayerUseUnknownEntityEvent(@NotNull Player who,
                           int entityId,
                           boolean attack,
                           @NotNull EquipmentSlot hand)  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
PlayerShearBlockEvent.getHand()
Gets the hand used to shear the block. 
 | 
| Constructor and Description | 
|---|
PlayerShearBlockEvent(@NotNull Player who,
                     @NotNull Block block,
                     @NotNull ItemStack item,
                     @NotNull EquipmentSlot hand,
                     @NotNull List<ItemStack> drops)  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
EntityLoadCrossbowEvent.getHand()
Gets the hand from which the crossbow was loaded. 
 | 
| Constructor and Description | 
|---|
EntityLoadCrossbowEvent(@NotNull LivingEntity entity,
                       @Nullable ItemStack crossbow,
                       @NotNull EquipmentSlot hand)  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
PlayerArmSwingEvent.getHand()
Returns the hand of the arm swing. 
 | 
| Constructor and Description | 
|---|
PlayerArmSwingEvent(@NotNull Player player,
                   @NotNull EquipmentSlot equipmentSlot)  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
Material.getEquipmentSlot()
Get the best suitable slot for this Material. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Multimap<Attribute,AttributeModifier> | 
Material.getItemAttributes(@NotNull EquipmentSlot equipmentSlot)
Returns an immutable multimap of attributes for the slot. 
 | 
Multimap<Attribute,AttributeModifier> | 
UnsafeValues.getItemAttributes(@NotNull Material material,
                 EquipmentSlot equipmentSlot)
Deprecated.  
Returns an immutable multimap of attributes for the material and slot. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
@Nullable EquipmentSlot | 
AttributeModifier.getSlot()
Get the  
EquipmentSlot this AttributeModifier is active on,
 or null if this modifier is applicable for any slot. | 
| Constructor and Description | 
|---|
AttributeModifier(@NotNull UUID uuid,
                 @NotNull String name,
                 double amount,
                 @NotNull AttributeModifier.Operation operation,
                 @Nullable EquipmentSlot slot)  | 
| Modifier and Type | Method and Description | 
|---|---|
Set<EquipmentSlot> | 
EnchantmentWrapper.getActiveSlots()  | 
abstract Set<EquipmentSlot> | 
Enchantment.getActiveSlots()
Gets the equipment slots where this enchantment is considered "active". 
 | 
| Modifier and Type | Method and Description | 
|---|---|
EquipmentSlot | 
LivingEntity.getHandRaised()
Gets the hand raised by this living entity. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Set<EquipmentSlot> | 
ArmorStand.getDisabledSlots()
Get the list of disabled slots 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ArmorStand.addDisabledSlots(EquipmentSlot... slots)
Disable specific slots, adding them
 to the currently disabled slots
 This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s)
 Note: Once a slot is disabled, the only way to get an item back it to break the armor stand. 
 | 
void | 
ArmorStand.addEquipmentLock(@NotNull EquipmentSlot slot,
                @NotNull ArmorStand.LockType lockType)
Locks the equipment slot with the specified
  
locking mechanism. | 
@NotNull ItemStack | 
ArmorStand.getItem(EquipmentSlot slot)
Returns the item the armor stand has
 equip in the given equipment slot 
 | 
boolean | 
ArmorStand.hasEquipmentLock(@NotNull EquipmentSlot slot,
                @NotNull ArmorStand.LockType lockType)
Returns if the ArmorStand has the specified
  
locking mechanism. | 
boolean | 
ArmorStand.isSlotDisabled(EquipmentSlot slot)
Check if a specific slot is disabled 
 | 
void | 
ArmorStand.removeDisabledSlots(EquipmentSlot... slots)
Remove the given slots from the disabled
 slots list, enabling them. 
 | 
void | 
ArmorStand.removeEquipmentLock(@NotNull EquipmentSlot slot,
                   @NotNull ArmorStand.LockType lockType)
Remove a  
locking mechanism. | 
void | 
ArmorStand.setDisabledSlots(EquipmentSlot... slots)
Set the disabled slots
 This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s)
 Note: Once a slot is disabled, the only way to get an item back it to break the armor stand. 
 | 
void | 
ArmorStand.setItem(EquipmentSlot slot,
       @Nullable ItemStack item)
Sets the item the armor stand has
 equip in the given equipment slot 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected EquipmentSlot | 
BlockPlaceEvent.hand  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
BlockPlaceEvent.getHand()
Gets the hand which placed the block 
 | 
| Constructor and Description | 
|---|
BlockMultiPlaceEvent(@NotNull List<BlockState> states,
                    @NotNull Block clicked,
                    @NotNull ItemStack itemInHand,
                    @NotNull Player thePlayer,
                    boolean canBuild,
                    EquipmentSlot hand)  | 
BlockPlaceEvent(@NotNull Block placedBlock,
               @NotNull BlockState replacedBlockState,
               @NotNull Block placedAgainst,
               @NotNull ItemStack itemInHand,
               @NotNull Player thePlayer,
               boolean canBuild,
               @NotNull EquipmentSlot hand)  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
EntityShootBowEvent.getHand()
Get the hand from which the bow was shot. 
 | 
| Constructor and Description | 
|---|
EntityShootBowEvent(@NotNull LivingEntity shooter,
                   @Nullable ItemStack bow,
                   @Nullable ItemStack consumable,
                   @NotNull Entity projectile,
                   @NotNull EquipmentSlot hand,
                   float force,
                   boolean consumeItem)  | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull EquipmentSlot | 
PlayerShearEntityEvent.getHand()
Gets the hand used to shear the entity. 
 | 
@Nullable EquipmentSlot | 
PlayerInteractEvent.getHand()
The hand used to perform this interaction. 
 | 
@NotNull EquipmentSlot | 
PlayerInteractEntityEvent.getHand()
The hand used to perform this interaction. 
 | 
@NotNull EquipmentSlot | 
PlayerBucketEvent.getHand()
The hand used to perform this action. 
 | 
@NotNull EquipmentSlot | 
PlayerArmorStandManipulateEvent.getSlot()
Returns the raw item slot of the armor stand in this event. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static EquipmentSlot | 
EquipmentSlot.valueOf(String name)
Returns the enum constant of this type with the specified name. 
 | 
static EquipmentSlot[] | 
EquipmentSlot.values()
Returns an array containing the constants of this enum type, in
the order they are declared. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
float | 
EntityEquipment.getDropChance(@NotNull EquipmentSlot slot)
Gets the drop chance of specified slot. 
 | 
@Nullable ItemStack | 
PlayerInventory.getItem(@NotNull EquipmentSlot slot)
Gets the ItemStack at the given equipment slot in the inventory. 
 | 
@NotNull ItemStack | 
EntityEquipment.getItem(@NotNull EquipmentSlot slot)
Gets the ItemStack at the given equipment slot in the inventory. 
 | 
void | 
EntityEquipment.setDropChance(@NotNull EquipmentSlot slot,
             float chance)
Sets the drop chance of the specified slot. 
 | 
void | 
PlayerInventory.setItem(@NotNull EquipmentSlot slot,
       @Nullable ItemStack item)
Stores the ItemStack at the given equipment slot in the inventory. 
 | 
void | 
EntityEquipment.setItem(@NotNull EquipmentSlot slot,
       @Nullable ItemStack item)
Stores the ItemStack at the given equipment slot in the inventory. 
 | 
void | 
EntityEquipment.setItem(@NotNull EquipmentSlot slot,
       @Nullable ItemStack item,
       boolean silent)
Stores the ItemStack at the given equipment slot in the inventory. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
@NotNull Multimap<Attribute,AttributeModifier> | 
ItemMeta.getAttributeModifiers(@NotNull EquipmentSlot slot)
Return an immutable copy of all  
Attributes and their
 AttributeModifiers for a given EquipmentSlot.Any AttributeModifier that does have have a given
 EquipmentSlot will be returned. | 
boolean | 
ItemMeta.removeAttributeModifier(@NotNull EquipmentSlot slot)
Remove all  
Attributes and AttributeModifiers for a
 given EquipmentSlot.If the given EquipmentSlot is null, this will remove all
 AttributeModifiers that do not have an EquipmentSlot set. | 
Copyright © 2022. All rights reserved.