Package net.neoforged.neoforge.event.level

Class PistonEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.level.BlockEvent

net.neoforged.neoforge.event.level.PistonEvent

Direct Known Subclasses:

PistonEvent.Post, PistonEvent.Pre

public abstract class PistonEvent
extends BlockEvent

Base piston event, use PistonEvent.Post and PistonEvent.Pre

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PistonEvent.PistonMoveType
static class	PistonEvent.Post	Fires after the piston has moved and set surrounding states.
static class	PistonEvent.Pre	Fires before the piston has updated block states.

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.level.BlockEvent

BlockEvent.BlockToolModificationEvent, BlockEvent.BreakEvent, BlockEvent.EntityMultiPlaceEvent, BlockEvent.EntityPlaceEvent, BlockEvent.FarmlandTrampleEvent, BlockEvent.FluidPlaceBlockEvent, BlockEvent.NeighborNotifyEvent, BlockEvent.PortalSpawnEvent

Field Summary

Fields

Modifier and Type	Field	Description
private final Direction	direction
private final PistonEvent.PistonMoveType	moveType

Constructor Summary

Constructors

Constructor	Description
PistonEvent(Level world, BlockPos pos, Direction direction, PistonEvent.PistonMoveType moveType)

Method Summary

Modifier and Type	Method	Description
Direction	getDirection()
BlockPos	getFaceOffsetPos()	Helper method that gets the piston position offset by its facing
PistonEvent.PistonMoveType	getPistonMoveType()
@Nullable PistonStructureResolver	getStructureHelper()

Methods inherited from class net.neoforged.neoforge.event.level.BlockEvent

getLevel, getPos, getState

Methods inherited from class java.lang.Object

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

Field Details

direction

private final Direction direction

moveType

private final PistonEvent.PistonMoveType moveType

Constructor Details

PistonEvent

public PistonEvent(Level world,
 BlockPos pos,
 Direction direction,
 PistonEvent.PistonMoveType moveType)

Parameters:

pos - - The position of the piston

direction - - The move direction of the piston

Method Details

getDirection

public Direction getDirection()

Returns:

The direction of the piston block

getFaceOffsetPos

public BlockPos getFaceOffsetPos()

Helper method that gets the piston position offset by its facing

getPistonMoveType

public PistonEvent.PistonMoveType getPistonMoveType()

Returns:

The movement type of the piston (extension, retraction)

getStructureHelper

@Nullable
public @Nullable PistonStructureResolver getStructureHelper()

Returns:

A piston structure helper for this movement. Returns null if the world stored is not a Level