Feature/block event block data

src/main/java/ch/njol/skript/events/EvtBlock.java

@@ -18,6 +18,9 @@
  */
 package ch.njol.skript.events;
 
+import org.bukkit.block.Block;
+import org.bukkit.block.BlockState;
+import org.bukkit.block.data.BlockData;
 import org.bukkit.event.Event;
 import org.bukkit.event.block.BlockBreakEvent;
 import org.bukkit.event.block.BlockBurnEvent;
@@ -29,7 +32,6 @@
 import org.bukkit.event.hanging.HangingEvent;
 import org.bukkit.event.hanging.HangingPlaceEvent;
 import org.bukkit.event.player.PlayerBucketEmptyEvent;
-import org.bukkit.event.player.PlayerBucketEvent;
 import org.bukkit.event.player.PlayerBucketFillEvent;
 import org.eclipse.jdt.annotation.Nullable;
 
@@ -42,7 +44,6 @@
 import ch.njol.skript.lang.SkriptEvent;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.registrations.Classes;
-import ch.njol.util.Checker;
 
 /**
  * @author Peter Güttinger
@@ -51,38 +52,45 @@
 public class EvtBlock extends SkriptEvent {
 
 	static {
-		// TODO 'block destroy' event for any kind of block destruction (player, water, trampling, fall (sand, toches, ...), etc) -> BlockPhysicsEvent?
-		// REMIND attacking an item frame first removes its item; include this in on block damage?
-		Skript.registerEvent("Break / Mine", EvtBlock.class, new Class[] {BlockBreakEvent.class, PlayerBucketFillEvent.class, HangingBreakEvent.class}, "[block] (break[ing]|1¦min(e|ing)) [[of] %itemtypes%]")
+		if (Skript.isRunningMinecraft(1, 13)) {
+			// TODO 'block destroy' event for any kind of block destruction (player, water, trampling, fall (sand, toches, ...), etc) -> BlockPhysicsEvent?
+			// REMIND attacking an item frame first removes its item; include this in on block damage?
+			Skript.registerEvent("Break / Mine", EvtBlock.class, new Class[]{BlockBreakEvent.class, PlayerBucketFillEvent.class, HangingBreakEvent.class}, "[block] (break[ing]|1¦min(e|ing)) [[of] %itemtypes/blockdatas%]")
 				.description("Called when a block is broken by a player. If you use 'on mine', only events where the broken block dropped something will call the trigger.")
-				.examples("on mine:", "on break of stone:", "on mine of any ore:")
-				.since("1.0 (break), <i>unknown</i> (mine)");
-		Skript.registerEvent("Burn", EvtBlock.class, BlockBurnEvent.class, "[block] burn[ing] [[of] %itemtypes%]")
+				.examples("on mine:", "on break of stone:", "on mine of any ore:", "on break of chest[facing=north]:", "on break of potatoes[age=7]:")
+				.requiredPlugins("Minecraft 1.13+ (BlockData)")
+				.since("1.0 (break), <i>unknown</i> (mine), INSERT VERSION (BlockData support)");
+			Skript.registerEvent("Burn", EvtBlock.class, BlockBurnEvent.class, "[block] burn[ing] [[of] %itemtypes/blockdatas%]")
 				.description("Called when a block is destroyed by fire.")
-				.examples("on burn:", "on burn of wood, fences, or chests:")
-				.since("1.0");
-		Skript.registerEvent("Place", EvtBlock.class, new Class[] {BlockPlaceEvent.class, PlayerBucketEmptyEvent.class, HangingPlaceEvent.class}, "[block] (plac(e|ing)|build[ing]) [[of] %itemtypes%]")
+				.examples("on burn:", "on burn of wood, fences, or chests:", "on burn of oak_log[axis=y]:")
+				.requiredPlugins("Minecraft 1.13+ (BlockData)")
+				.since("1.0, INSERT VERSION (BlockData support)");
+			Skript.registerEvent("Place", EvtBlock.class, new Class[]{BlockPlaceEvent.class, PlayerBucketEmptyEvent.class, HangingPlaceEvent.class}, "[block] (plac(e|ing)|build[ing]) [[of] %itemtypes/blockdatas%]")
 				.description("Called when a player places a block.")
-				.examples("on place:", "on place of a furnace, workbench or chest:")
-				.since("1.0");
-		Skript.registerEvent("Fade", EvtBlock.class, BlockFadeEvent.class, "[block] fad(e|ing) [[of] %itemtypes%]")
+				.examples("on place:", "on place of a furnace, workbench or chest:", "on break of chest[type=right] or chest[type=left]")
+				.requiredPlugins("Minecraft 1.13+ (BlockData)")
+				.since("1.0, INSERT VERSION (BlockData support)");
+			Skript.registerEvent("Fade", EvtBlock.class, BlockFadeEvent.class, "[block] fad(e|ing) [[of] %itemtypes/blockdatas%]")
 				.description("Called when a block 'fades away', e.g. ice or snow melts.")
-				.examples("on fade of snow or ice:")
-				.since("1.0");
-		Skript.registerEvent("Form", EvtBlock.class, BlockFormEvent.class, "[block] form[ing] [[of] %itemtypes%]")
+				.examples("on fade of snow or ice:", "on fade of snow[layers=2]")
+				.requiredPlugins("Minecraft 1.13+ (BlockData)")
+				.since("1.0, INSERT VERSION (BlockData support)");
+			Skript.registerEvent("Form", EvtBlock.class, BlockFormEvent.class, "[block] form[ing] [[of] %itemtypes/blockdatas%]")
 				.description("Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see <a href='#spread'>spread event</a>).")
 				.examples("on form of snow:", "on form of a mushroom:")
-				.since("1.0");
+				.requiredPlugins("Minecraft 1.13+ (BlockData)")
+				.since("1.0, INSERT VERSION (BlockData support)");
+		}
 	}
 
 	@Nullable
-	private Literal<ItemType> types;
+	private Literal<Object> types;
 
 	private boolean mine = false;
 
 	@Override
 	public boolean init(final Literal<?>[] args, final int matchedPattern, final ParseResult parser) {
-		types = (Literal<ItemType>) args[0];
+		types = (Literal<Object>) args[0];
 		mine = parser.mark == 1;
 		return true;
 	}
@@ -98,34 +106,47 @@ public boolean check(final Event e) {
 			return true;
 
 		ItemType item;
+		BlockData blockData = null;
+
 		if (e instanceof BlockFormEvent) {
-			item = new ItemType(((BlockFormEvent) e).getNewState());
+			BlockFormEvent blockFormEvent = (BlockFormEvent) e;
+			BlockState newState = blockFormEvent.getNewState();
+			item = new ItemType(newState);
+			blockData = newState.getBlockData();
 		} else if (e instanceof BlockEvent) {
-			item = new ItemType(((BlockEvent) e).getBlock());
+			BlockEvent blockEvent = (BlockEvent) e;
+			Block block = blockEvent.getBlock();
+			item = new ItemType(block);
+			blockData = block.getBlockData();
 		} else if (e instanceof PlayerBucketFillEvent) {
-			item = new ItemType(((PlayerBucketEvent) e).getBlockClicked().getRelative(((PlayerBucketEvent) e).getBlockFace()));
+			PlayerBucketFillEvent playerBucketFillEvent = ((PlayerBucketFillEvent) e);
+			Block relative = playerBucketFillEvent.getBlockClicked().getRelative(playerBucketFillEvent.getBlockFace());
+			item = new ItemType(relative);
+			blockData = relative.getBlockData();
 		} else if (e instanceof PlayerBucketEmptyEvent) {
-			item = new ItemType(((PlayerBucketEmptyEvent) e).getItemStack());
-		} else if (Skript.isRunningMinecraft(1, 4, 3) && e instanceof HangingEvent) {
+			PlayerBucketEmptyEvent playerBucketEmptyEvent = ((PlayerBucketEmptyEvent) e);
+			item = new ItemType(playerBucketEmptyEvent.getItemStack());
+		} else if (e instanceof HangingEvent) {
 			final EntityData<?> d = EntityData.fromEntity(((HangingEvent) e).getEntity());
-			return types.check(e, new Checker<ItemType>() {
-				@Override
-				public boolean check(final @Nullable ItemType t) {
-					return t != null && Relation.EQUAL.is(DefaultComparators.entityItemComparator.compare(d, t));
-				}
+			return types.check(e, o -> {
+				if (o instanceof ItemType)
+					return Relation.EQUAL.is(DefaultComparators.entityItemComparator.compare(d, ((ItemType) o)));
+				return false;
 			});
 		} else {
 			assert false;
 			return false;
 		}
 
 		final ItemType itemF = item;
-
-		return types.check(e, new Checker<ItemType>() {
-			@Override
-			public boolean check(final @Nullable ItemType t) {
-				return t != null && t.isSupertypeOf(itemF);
-			}
+		BlockData finalBlockData = blockData;
+
+		return types.check(e, o -> {
+			if (o instanceof ItemType)
+				return ((ItemType) o).isSupertypeOf(itemF);
+			else if (o instanceof BlockData && finalBlockData != null)
+				return finalBlockData.matches(((BlockData) o));
+			return false;
 		});
 	}
 

src/main/java/ch/njol/skript/events/EvtBlockLegacy.java

@@ -0,0 +1,138 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.events;
+
+import org.bukkit.event.Event;
+import org.bukkit.event.block.BlockBreakEvent;
+import org.bukkit.event.block.BlockBurnEvent;
+import org.bukkit.event.block.BlockEvent;
+import org.bukkit.event.block.BlockFadeEvent;
+import org.bukkit.event.block.BlockFormEvent;
+import org.bukkit.event.block.BlockPlaceEvent;
+import org.bukkit.event.hanging.HangingBreakEvent;
+import org.bukkit.event.hanging.HangingEvent;
+import org.bukkit.event.hanging.HangingPlaceEvent;
+import org.bukkit.event.player.PlayerBucketEmptyEvent;
+import org.bukkit.event.player.PlayerBucketEvent;
+import org.bukkit.event.player.PlayerBucketFillEvent;
+import org.eclipse.jdt.annotation.Nullable;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.aliases.ItemType;
+import ch.njol.skript.classes.Comparator.Relation;
+import ch.njol.skript.classes.data.DefaultComparators;
+import ch.njol.skript.entity.EntityData;
+import ch.njol.skript.lang.Literal;
+import ch.njol.skript.lang.SkriptEvent;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.registrations.Classes;
+import ch.njol.util.Checker;
+
+/**
+ * @author Peter Güttinger
+ */
+// Class can be deleted when legacy support is dropped (new class = EvtBlock)
+@SuppressWarnings({"deprecation", "unchecked"})
+public class EvtBlockLegacy extends SkriptEvent {
+
+	static {
+		if (!Skript.isRunningMinecraft(1, 13)) {
+			Skript.registerEvent("Break / Mine", EvtBlockLegacy.class, new Class[]{BlockBreakEvent.class, PlayerBucketFillEvent.class, HangingBreakEvent.class}, "[block] (break[ing]|1¦min(e|ing)) [[of] %itemtypes%]")
+				.description("Called when a block is broken by a player. If you use 'on mine', only events where the broken block dropped something will call the trigger.")
+				.examples("on mine:", "on break of stone:", "on mine of any ore:")
+				.since("1.0 (break), <i>unknown</i> (mine)");
+			Skript.registerEvent("Burn", EvtBlockLegacy.class, BlockBurnEvent.class, "[block] burn[ing] [[of] %itemtypes%]")
+				.description("Called when a block is destroyed by fire.")
+				.examples("on burn:", "on burn of wood, fences, or chests:")
+				.since("1.0");
+			Skript.registerEvent("Place", EvtBlockLegacy.class, new Class[]{BlockPlaceEvent.class, PlayerBucketEmptyEvent.class, HangingPlaceEvent.class}, "[block] (plac(e|ing)|build[ing]) [[of] %itemtypes%]")
+				.description("Called when a player places a block.")
+				.examples("on place:", "on place of a furnace, workbench or chest:")
+				.since("1.0");
+			Skript.registerEvent("Fade", EvtBlockLegacy.class, BlockFadeEvent.class, "[block] fad(e|ing) [[of] %itemtypes%]")
+				.description("Called when a block 'fades away', e.g. ice or snow melts.")
+				.examples("on fade of snow or ice:")
+				.since("1.0");
+			Skript.registerEvent("Form", EvtBlockLegacy.class, BlockFormEvent.class, "[block] form[ing] [[of] %itemtypes%]")
+				.description("Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see <a href='#spread'>spread event</a>).")
+				.examples("on form of snow:", "on form of a mushroom:")
+				.since("1.0");
+		}
+	}
+
+	@Nullable
+	private Literal<ItemType> types;
+
+	private boolean mine = false;
+
+	@Override
+	public boolean init(final Literal<?>[] args, final int matchedPattern, final ParseResult parser) {
+		types = (Literal<ItemType>) args[0];
+		mine = parser.mark == 1;
+		return true;
+	}
+
+	@SuppressWarnings("null")
+	@Override
+	public boolean check(final Event e) {
+		if (mine && e instanceof BlockBreakEvent) {
+			if (((BlockBreakEvent) e).getBlock().getDrops(((BlockBreakEvent) e).getPlayer().getItemInHand()).isEmpty())
+				return false;
+		}
+		if (types == null)
+			return true;
+
+		ItemType item;
+		if (e instanceof BlockFormEvent) {
+			item = new ItemType(((BlockFormEvent) e).getNewState());
+		} else if (e instanceof BlockEvent) {
+			item = new ItemType(((BlockEvent) e).getBlock());
+		} else if (e instanceof PlayerBucketFillEvent) {
+			item = new ItemType(((PlayerBucketEvent) e).getBlockClicked().getRelative(((PlayerBucketEvent) e).getBlockFace()));
+		} else if (e instanceof PlayerBucketEmptyEvent) {
+			item = new ItemType(((PlayerBucketEmptyEvent) e).getItemStack());
+		} else if (Skript.isRunningMinecraft(1, 4, 3) && e instanceof HangingEvent) {
+			final EntityData<?> d = EntityData.fromEntity(((HangingEvent) e).getEntity());
+			return types.check(e, new Checker<ItemType>() {
+				@Override
+				public boolean check(final @Nullable ItemType t) {
+					return t != null && Relation.EQUAL.is(DefaultComparators.entityItemComparator.compare(d, t));
+				}
+			});
+		} else {
+			assert false;
+			return false;
+		}
+
+		final ItemType itemF = item;
+
+		return types.check(e, new Checker<ItemType>() {
+			@Override
+			public boolean check(final @Nullable ItemType t) {
+				return t != null && t.isSupertypeOf(itemF);
+			}
+		});
+	}
+
+	@Override
+	public String toString(final @Nullable Event e, final boolean debug) {
+		return "break/place/burn/fade/form of " + Classes.toString(types);
+	}
+
+}