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

Class ItemEntityPickupEvent.Pre

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.player.ItemEntityPickupEvent

net.neoforged.neoforge.event.entity.player.ItemEntityPickupEvent.Pre

Enclosing class:

ItemEntityPickupEvent

public static class ItemEntityPickupEvent.Pre
extends ItemEntityPickupEvent

This event is fired when a player collides with an ItemEntity on the ground. It can be used to determine if the item may be picked up by the player.

If the pickup is successful (either by force or by default rules) ItemEntityPickupEvent.Post will be fired.

This event is only fired on the logical server.

Nested Class Summary

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

ItemEntityPickupEvent.Post, ItemEntityPickupEvent.Pre

Field Summary

Fields

Modifier and Type	Field	Description
private TriState	canPickup

Constructor Summary

Constructors

Constructor	Description
Pre(Player player, ItemEntity item)

Method Summary

Modifier and Type	Method	Description
TriState	canPickup()	Returns the current pickup state.
void	setCanPickup(TriState state)	Changes if the player may pickup the item.

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

getItemEntity, getPlayer

Methods inherited from class java.lang.Object

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

Field Details

canPickup

private TriState canPickup

Constructor Details

Pre

public Pre(Player player,
 ItemEntity item)

Method Details

setCanPickup

public void setCanPickup(TriState state)

Changes if the player may pickup the item. Setting TriState.TRUE or TriState.FALSE will allow/deny the pickup respectively.

The default rules require that ItemEntity.pickupDelay is zero, and that ItemEntity.target matches (or is null).

Parameters:

state - The new pickup state.

canPickup

public TriState canPickup()

Returns the current pickup state.

Returns:

the current pickup state

See Also:

• setCanPickup(TriState)