From 29d059d6591a9b1306a1d2528ad651b396c1ea75 Mon Sep 17 00:00:00 2001 From: Jake Potrebic Date: Wed, 22 Dec 2021 09:51:48 -0800 Subject: [PATCH] Fix sticky pistons and BlockPistonRetractEvent There is an explicit check in the handling code for empty pistons that prevents sticky pistons from firing the event. However when we look back at the history we see that this check was originally added so that ONLY sticky pistons would fire the retract event. I'm not sure why. https://hub.spigotmc.org/stash/projects/SPIGOT/repos/craftbukkit/commits/1092acbddf07edfa4100bc6824504ac75088e913 Over the course of several updates, the meaning of that field appears to have changed from "is NOT sticky" to "is sticky". So now its having the opposite effect. Only normal pistons fire the retraction event. And like all things in CB, it's just been carried around since. If we are to believe the history, the correct fix for this issue is to flip it so it only fires for sticky pistons, but that puts us in a bind. It's already firing for non-sticky pistons, changing it now would likely result in breakage. Furthermore, there is little documentation as to WHY that was ever intended to be the case. Instead we opt to remove the check entirely so that the event fires for all piston types. Co-authored-by: Zach Brown <1254957+zachbr@users.noreply.github.com> Co-authored-by: Madeline Miller --- .../block/piston/PistonBaseBlock.java.patch | 57 ++++++++++++++----- 1 file changed, 42 insertions(+), 15 deletions(-) diff --git a/paper-server/patches/sources/net/minecraft/world/level/block/piston/PistonBaseBlock.java.patch b/paper-server/patches/sources/net/minecraft/world/level/block/piston/PistonBaseBlock.java.patch index 6cf1b78afd..2bd5e17a27 100644 --- a/paper-server/patches/sources/net/minecraft/world/level/block/piston/PistonBaseBlock.java.patch +++ b/paper-server/patches/sources/net/minecraft/world/level/block/piston/PistonBaseBlock.java.patch @@ -14,27 +14,54 @@ public class PistonBaseBlock extends DirectionalBlock { -@@ -154,7 +161,19 @@ - } +@@ -155,6 +162,18 @@ } } -+ -+ // CraftBukkit start -+ if (!this.isSticky) { -+ org.bukkit.block.Block block = world.getWorld().getBlockAt(pos.getX(), pos.getY(), pos.getZ()); -+ BlockPistonRetractEvent event = new BlockPistonRetractEvent(block, ImmutableList.of(), CraftBlock.notchToBlockFace(enumdirection)); -+ world.getCraftServer().getPluginManager().callEvent(event); -+ if (event.isCancelled()) { -+ return; -+ } -+ } ++ // CraftBukkit start ++ // if (!this.isSticky) { // Paper - Fix sticky pistons and BlockPistonRetractEvent; Move further down ++ // org.bukkit.block.Block block = world.getWorld().getBlockAt(pos.getX(), pos.getY(), pos.getZ()); ++ // BlockPistonRetractEvent event = new BlockPistonRetractEvent(block, ImmutableList.of(), CraftBlock.notchToBlockFace(enumdirection)); ++ // world.getCraftServer().getPluginManager().callEvent(event); ++ // ++ // if (event.isCancelled()) { ++ // return; ++ // } ++ // } + // PAIL: checkME - what happened to setTypeAndData? + // CraftBukkit end world.blockEvent(pos, this, b0, enumdirection.get3DDataValue()); } -@@ -335,7 +354,49 @@ +@@ -229,6 +248,13 @@ + + BlockState iblockdata2 = (BlockState) ((BlockState) Blocks.MOVING_PISTON.defaultBlockState().setValue(MovingPistonBlock.FACING, enumdirection)).setValue(MovingPistonBlock.TYPE, this.isSticky ? PistonType.STICKY : PistonType.DEFAULT); + ++ // Paper start - Fix sticky pistons and BlockPistonRetractEvent; Move empty piston retract call to fix multiple event fires ++ if (!this.isSticky) { ++ if (!new BlockPistonRetractEvent(CraftBlock.at(world, pos), java.util.Collections.emptyList(), CraftBlock.notchToBlockFace(enumdirection)).callEvent()) { ++ return false; ++ } ++ } ++ // Paper end - Fix sticky pistons and BlockPistonRetractEvent + world.setBlock(pos, iblockdata2, 20); + world.setBlockEntity(MovingPistonBlock.newMovingBlockEntity(pos, iblockdata2, (BlockState) this.defaultBlockState().setValue(PistonBaseBlock.FACING, Direction.from3DDataValue(data & 7)), enumdirection, false, true)); + world.blockUpdated(pos, iblockdata2.getBlock()); +@@ -255,6 +281,13 @@ + if (type == 1 && !iblockdata3.isAir() && PistonBaseBlock.isPushable(iblockdata3, world, blockposition1, enumdirection.getOpposite(), false, enumdirection) && (iblockdata3.getPistonPushReaction() == PushReaction.NORMAL || iblockdata3.is(Blocks.PISTON) || iblockdata3.is(Blocks.STICKY_PISTON))) { + this.moveBlocks(world, pos, enumdirection, false); + } else { ++ // Paper start - Fix sticky pistons and BlockPistonRetractEvent; fire BlockPistonRetractEvent for sticky pistons retracting nothing (air) ++ if (type == TRIGGER_CONTRACT && iblockdata2.isAir()) { ++ if (!new BlockPistonRetractEvent(CraftBlock.at(world, pos), java.util.Collections.emptyList(), CraftBlock.notchToBlockFace(enumdirection)).callEvent()) { ++ return false; ++ } ++ } ++ // Paper end - Fix sticky pistons and BlockPistonRetractEvent + world.removeBlock(pos.relative(enumdirection), false); + } + } +@@ -335,7 +368,49 @@ BlockState[] aiblockdata = new BlockState[list.size() + list2.size()]; Direction enumdirection1 = extend ? dir : dir.getOpposite(); int i = 0; @@ -84,7 +111,7 @@ BlockPos blockposition3; int j; BlockState iblockdata1; -@@ -345,7 +406,7 @@ +@@ -345,7 +420,7 @@ iblockdata1 = world.getBlockState(blockposition3); BlockEntity tileentity = iblockdata1.hasBlockEntity() ? world.getBlockEntity(blockposition3) : null; @@ -93,7 +120,7 @@ world.setBlock(blockposition3, Blocks.AIR.defaultBlockState(), 18); world.gameEvent((Holder) GameEvent.BLOCK_DESTROY, blockposition3, GameEvent.Context.of(iblockdata1)); if (!iblockdata1.is(BlockTags.FIRE)) { -@@ -358,13 +419,25 @@ +@@ -358,13 +433,25 @@ BlockState iblockdata2; for (j = list.size() - 1; j >= 0; --j) {