Class PlayerEvent.HarvestCheck

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.PlayerEvent.HarvestCheck

Enclosing class:

PlayerEvent

public static class PlayerEvent.HarvestCheck
extends PlayerEvent

HarvestCheck is fired when a player attempts to harvest a block.

This event is fired whenever a player attempts to harvest a block in Player.hasCorrectToolForDrops(BlockState).

This event is fired via the EventHooks.doPlayerHarvestCheck(Player, BlockState, BlockGetter, BlockPos).

• state contains the BlockState that is being checked for harvesting.
• success contains the boolean value for whether the Block will be successfully harvested.
• PlayerEvent.getEntity() contains the player that caused this event to occur.

This event is not cancellable, and is fired on the game event bus.

Nested Class Summary

Nested classes/interfaces inherited from class PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, 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 LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private final BlockGetter	level
private final BlockPos	pos
private final BlockState	state
private boolean	success

Constructor Summary

Constructors

Constructor	Description
HarvestCheck(Player player, BlockState state, BlockGetter level, BlockPos pos, boolean success)

Method Summary

Modifier and Type	Method	Description
boolean	canHarvest()
BlockGetter	getLevel()
BlockPos	getPos()
BlockState	getTargetBlock()
void	setCanHarvest(boolean success)

Methods inherited from class PlayerEvent

getEntity

Methods inherited from class Object

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

Field Details

state

private final BlockState state

level

private final BlockGetter level

pos

private final BlockPos pos

success

private boolean success

Constructor Details

HarvestCheck

public HarvestCheck(Player player,
 BlockState state,
 BlockGetter level,
 BlockPos pos,
 boolean success)

Method Details

getTargetBlock

public BlockState getTargetBlock()

getLevel

public BlockGetter getLevel()

getPos

public BlockPos getPos()

canHarvest

public boolean canHarvest()

setCanHarvest

public void setCanHarvest(boolean success)