Class PlayerEvent.BreakSpeed

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.BreakSpeed

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

PlayerEvent

public static class PlayerEvent.BreakSpeed
extends PlayerEvent
implements net.neoforged.bus.api.ICancellableEvent

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

This event is fired whenever a player attempts to harvest a block in

invalid reference

Player#getDigSpeed(BlockState, BlockPos)

.

This event is fired via the EventHooks.getBreakSpeed(Player, BlockState, float, BlockPos).

• state contains the block being broken.
• originalSpeed contains the original speed at which the player broke the block.
• newSpeed contains the newSpeed at which the player will break the block.
• pos contains the coordinates at which this event is occurring. Optional value.
• PlayerEvent.getEntity() contains the player that caused this event to occur.

This event is ICancellableEvent. If it is canceled, the player is unable to break the block.

This event is fired on the NeoForge.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 static final BlockPos	LEGACY_UNKNOWN
private float	newSpeed
private final float	originalSpeed
private final Optional<BlockPos>	pos
private final BlockState	state

Constructor Summary

Constructors

Constructor	Description
BreakSpeed(Player player, BlockState state, float original, @Nullable BlockPos pos)

Method Summary

Modifier and Type	Method	Description
float	getNewSpeed()
float	getOriginalSpeed()
Optional<BlockPos>	getPosition()
BlockState	getState()
void	setNewSpeed(float newSpeed)

Methods inherited from class PlayerEvent

getEntity

Methods inherited from class Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

LEGACY_UNKNOWN

private static final BlockPos LEGACY_UNKNOWN

state

private final BlockState state

originalSpeed

private final float originalSpeed

newSpeed

private float newSpeed

pos

private final Optional<BlockPos> pos

Constructor Details

BreakSpeed

public BreakSpeed(Player player,
 BlockState state,
 float original,
 @Nullable BlockPos pos)

Method Details

getState

public BlockState getState()

getOriginalSpeed

public float getOriginalSpeed()

getNewSpeed

public float getNewSpeed()

setNewSpeed

public void setNewSpeed(float newSpeed)

getPosition

public Optional<BlockPos> getPosition()