Class PistonActivateAfterEventSignalBeta

Remarks

Adds a callback that will be called when a piston expands or retracts.

This function can't be called in read-only mode.

Example

pistonAfterEvent.ts

  // set up a couple of piston blocks
  let piston = overworld.getBlock(targetLocation);
  let button = overworld.getBlock({ x: targetLocation.x, y: targetLocation.y + 1, z: targetLocation.z });

  if (piston === undefined || button === undefined) {
    log("Could not find block at location.");
    return -1;
  }

  piston.setPermutation(mc.BlockPermutation.resolve('piston').withState('facing_direction', 3));
  button.setPermutation(mc.BlockPermutation.resolve('acacia_button').withState('facing_direction', 1));

  mc.world.afterEvents.pistonActivate.subscribe((pistonEvent: mc.PistonActivateAfterEvent) => {
    let eventLoc = pistonEvent.piston.block.location;

    if (eventLoc.x === targetLocation.x && eventLoc.y === targetLocation.y && eventLoc.z === targetLocation.z) {
      log(
        "Piston event at " +
          mc.system.currentTick +
          (pistonEvent.piston.isMoving ? " Moving" : "") +
          (pistonEvent.piston.isExpanding ? " Expanding" : "") +
          (pistonEvent.piston.isExpanded ? " Expanded" : "") +
          (pistonEvent.piston.isRetracting ? " Retracting" : "") +
          (pistonEvent.piston.isRetracted ? " Retracted" : "")
      );
    }
  });
Copy

Example

pistonEvent.ts

let canceled = false;

const pistonLoc: mc.Vector3 = {
  x: Math.floor(targetLocation.x) + 1,
  y: Math.floor(targetLocation.y) + 2,
  z: Math.floor(targetLocation.z) + 1,
};

const pistonCallback = mc.world.beforeEvents.pistonActivate.subscribe((pistonEvent: mc.PistonActivateBeforeEvent) => {
  if (pistonEvent.piston.location.equals(pistonLoc)) {
    log("Cancelling piston event");
    pistonEvent.cancel = true;
    canceled = true;
  }
});

Copy

Remarks

Removes a callback from being called when a piston expands or retracts.

This function can't be called in read-only mode.

Throws

This function can throw errors.