PistonEvent
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.forge.api.event.block.piston.PistonEvent;Extends
PistonEvent extends BlockEvent.
Members
cancel()
Cancels the event. Same as script.zs
setCanceled(true)// PistonEvent.cancel();myPistonEvent.cancel();Getter
// PistonEvent.cancelable as boolmyPistonEvent.cancelable
Return Type:
bool
cancelable() as bool
// PistonEvent.cancelable() as bool;myPistonEvent.cancelable();
Return Type:
bool
Getter
// PistonEvent.canceled as boolmyPistonEvent.canceled
Return Type:
bool
Setter
// PistonEvent.canceled = (cancel as bool);myPistonEvent.canceled = myBool;Parameters:
cancel: bool Type: bool canceled() as bool
// PistonEvent.canceled() as bool;myPistonEvent.canceled();
Return Type:
bool
canceled(cancel as bool)
// PistonEvent.canceled(cancel as bool);myPistonEvent.canceled(myBool);Parameters:
cancel: bool Type: bool Getter
Gets the direction that the piston is facing.script.zs
// PistonEvent.direction as DirectionmyPistonEvent.direction
Return Type:
Direction
Getter
Gets the position that the piston is facing towards.script.zs
// PistonEvent.faceOffsetPos as BlockPosmyPistonEvent.faceOffsetPos
Return Type:
BlockPos
Getter
// PistonEvent.hasResult as boolmyPistonEvent.hasResult
Return Type:
bool
hasResult() as bool
// PistonEvent.hasResult() as bool;myPistonEvent.hasResult();
Return Type:
bool
Getter
// PistonEvent.level as LevelAccessormyPistonEvent.level
Return Type:
LevelAccessor
Getter
Gets the move type of the piston (is it extending or retracting).script.zs
// PistonEvent.pistonMoveType as PistonMoveTypemyPistonEvent.pistonMoveType
Return Type:
PistonMoveType
Getter
// PistonEvent.pos as BlockPosmyPistonEvent.pos
Return Type:
BlockPos
Getter
// PistonEvent.result as ResultmyPistonEvent.result
Return Type:
EventResult
Setter
// PistonEvent.result = (result as Result);myPistonEvent.result = myResult;Parameters:
result: EventResult Type: EventResult result() as Result
result(result as Result)
// PistonEvent.result(result as Result);myPistonEvent.result(myResult);Parameters:
result: EventResult Type: EventResult setAllow()
sets the event's result to script.zs
allow// PistonEvent.setAllow();myPistonEvent.setAllow();setDefault()
sets the event's result to script.zs
default// PistonEvent.setDefault();myPistonEvent.setDefault();setDeny()
sets the event's result to script.zs
deny// PistonEvent.setDeny();myPistonEvent.setDeny();Getter
// PistonEvent.state as BlockStatemyPistonEvent.state
Return Type:
BlockState
Getter
Gets a **nullable** structure resolver that can be used to get all the blocks that will be affected by the piston.
script.zs
Be sure to call the resolve() method on the structure resolver
// PistonEvent.structureHelper as PistonStructureResolvermyPistonEvent.structureHelper
Return Type:
PistonStructureResolver