Package net.neoforged.neoforge.event.entity.player

Class PlayerDestroyItemEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

net.neoforged.neoforge.event.entity.player.PlayerDestroyItemEvent

public class PlayerDestroyItemEvent
extends PlayerEvent

PlayerDestroyItemEvent is fired when a player destroys an item.
This event is fired whenever a player destroys an item in MultiPlayerGameMode.destroyBlock(BlockPos), MultiPlayerGameMode.useItem(Player, InteractionHand), MultiPlayerGameMode.useItemOn(LocalPlayer, InteractionHand, BlockHitResult) , Player.attack(Entity), Player#hurtCurrentlyUsedShield(float), Player.interactOn(Entity, InteractionHand), CommonHooks.getCraftingRemainingItem(ItemStack), ServerPlayerGameMode.useItem(ServerPlayer, Level, ItemStack, InteractionHand) , ServerPlayerGameMode.useItemOn(ServerPlayer, Level, ItemStack, InteractionHand, BlockHitResult) and ServerPlayerGameMode.destroyBlock(BlockPos).

original contains the original ItemStack before the item was destroyed.
(@link #hand) contains the hand that the current item was held in.

This event is not ICancellableEvent.

This event does not have a result. Event.HasResult

This event is fired from EventHooks.onPlayerDestroyItem(Player, ItemStack, InteractionHand).
This event is fired on the NeoForge.EVENT_BUS.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingTickEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable InteractionHand	hand
private final ItemStack	original

Constructor Summary

Constructors

Constructor	Description
PlayerDestroyItemEvent(Player player, ItemStack original, @Nullable InteractionHand hand)

Method Summary

Modifier and Type	Method	Description
@Nullable InteractionHand	getHand()
ItemStack	getOriginal()

Methods inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

getEntity

Methods inherited from class net.neoforged.bus.api.Event

getResult, hasResult, setResult

Methods inherited from class java.lang.Object

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

Field Details

original

private final ItemStack original

hand

@Nullable
private final @Nullable InteractionHand hand

Constructor Details

PlayerDestroyItemEvent

public PlayerDestroyItemEvent(Player player,
 ItemStack original,
 @Nullable
 @Nullable InteractionHand hand)

Method Details

getOriginal

public ItemStack getOriginal()

getHand

@Nullable
public @Nullable InteractionHand getHand()