PrePistonEvent

Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.neoforge.api.event.block.piston.PrePistonEvent;

Extends

PrePistonEvent extends PistonEvent.

Implements

PrePistonEvent implements the following interfaces:

ICancellableEvent

Listening to the event

This event can be listened to like so:

events.register<crafttweaker.neoforge.api.event.block.piston.PrePistonEvent>(event => {
    println("PrePistonEvent ran!");
});

Members

Cancels the event. Same as setCanceled(true)

// Pre.cancel();
event.cancel();

// Pre.canceled as bool
event.canceled

Return Type: bool

// Pre.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel: bool Type: bool

// Pre.canceled() as bool;
event.canceled();

Return Type: bool

// Pre.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel: bool Type: bool

Gets the direction that the piston is facing.

// Pre.direction as Direction
event.direction

Return Type: Direction

Gets the position that the piston is facing towards.

// Pre.faceOffsetPos as BlockPos
event.faceOffsetPos

Return Type: BlockPos

// Pre.level as Level
event.level

Return Type: Level

// Pre.level as LevelAccessor
event.level

Return Type: LevelAccessor

Gets the move type of the piston (is it extending or retracting).

// Pre.pistonMoveType as PistonMoveType
event.pistonMoveType

Return Type: PistonMoveType

// Pre.pos as BlockPos
event.pos

Return Type: BlockPos

// Pre.state as BlockState
event.state

Return Type: BlockState

Gets a **nullable** structure resolver that can be used to get all the blocks that will be affected by the piston.

Be sure to call the resolve() method on the structure resolver

// Pre.structureHelper as PistonStructureResolver
event.structureHelper

Return Type: PistonStructureResolver