Merge branch 'dev/patch' into feature/rename-potion-type

.github/workflows/archive-docs.yml

@@ -8,7 +8,6 @@ on:
 jobs:
   archive-docs:
       if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
-      needs: release-docs
       runs-on: ubuntu-latest
       steps:
           - name: Configure workflow

gradle.properties

@@ -5,7 +5,7 @@ org.gradle.parallel=true
 
 groupid=ch.njol
 name=skript
-version=2.9.0-pre1
+version=2.9.0
 jarName=Skript.jar
 testEnv=java21/paper-1.21.0
 testEnvJavaVersion=21

src/main/java/ch/njol/skript/aliases/ItemData.java

@@ -278,7 +278,7 @@ public boolean equals(final @Nullable Object obj) {
 			return false;
 
 		ItemData other = (ItemData) obj;
-		if (isAlias) { // This is alias, other item might not be
+		if (isAlias()) { // This is alias, other item might not be
 			return other.matchAlias(this).isAtLeast(MatchQuality.SAME_ITEM);
 		} else { // This is not alias, but other might be
 			return matchAlias(other).isAtLeast(MatchQuality.SAME_ITEM);

src/main/java/ch/njol/skript/aliases/ItemType.java

@@ -612,15 +612,27 @@ public ItemType clone() {
 				.collect(Collectors.toList());
 		if (datas.isEmpty())
 			return null;
-		int numItems = datas.size();
-		int index = random.nextInt(numItems);
-		ItemStack is = datas.get(index).getStack();
+		ItemStack is = datas.get(random.nextInt(datas.size())).getStack();
 		assert is != null; // verified above
 		is = is.clone();
 		is.setAmount(getAmount());
 		return is;
 	}
 
+	/**
+	 * @return One random ItemStack or Material that this ItemType represents.
+	 * A Material may only be returned for ItemStacks containing a Material where {@link Material#isItem()} is false.
+	 */
+	public Object getRandomStackOrMaterial() {
+		ItemData randomData = types.get(random.nextInt(types.size()));
+		ItemStack stack = randomData.getStack();
+		if (stack == null)
+			return randomData.getType();
+		stack = stack.clone();
+		stack.setAmount(getAmount());
+		return stack;
+	}
+
 	/**
 	 * Test whether this ItemType can be put into the given inventory completely.
 	 * <p>
@@ -1396,8 +1408,11 @@ public void clearItemMeta() {
 		globalMeta = null;
 	}
 
+	/**
+	 * @return A random Material this ItemType represents.
+	 */
 	public Material getMaterial() {
-		ItemData data = types.get(0);
+		ItemData data = types.get(random.nextInt(types.size()));
 		if (data == null)
 			throw new IllegalStateException("material not found");
 		return data.getType();

src/main/java/ch/njol/skript/bukkitutil/InventoryUtils.java

@@ -0,0 +1,111 @@
+package ch.njol.skript.bukkitutil;
+
+import ch.njol.skript.Skript;
+import org.bukkit.inventory.Inventory;
+import org.bukkit.inventory.InventoryView;
+import org.eclipse.jdt.annotation.Nullable;
+
+import java.lang.invoke.MethodHandle;
+import java.lang.invoke.MethodHandles;
+import java.lang.invoke.MethodType;
+
+/**
+ * Utilities for inventories.
+ * In newer versions (1.21+), InventoryView is an interface instead of an abstract class
+ * Directing calling InventoryView#getTitle on 1.20.6 and below results in an IncompatibleClassChangeError
+ *  as an interface, not an abstract class, is expected.
+ */
+public class InventoryUtils {
+
+	private static final @Nullable MethodHandle GET_TITLE;
+	private static final @Nullable MethodHandle GET_INVENTORY;
+	private static final @Nullable MethodHandle CONVERT_SLOT;
+	private static final @Nullable MethodHandle GET_TOP_INVENTORY;
+	private static final @Nullable MethodHandle GET_BOTTOM_INVENTORY;
+
+	static {
+		MethodHandle getTitle = null;
+		MethodHandle getInventory = null;
+		MethodHandle convertSlot = null;
+		MethodHandle getTopInventory = null;
+		MethodHandle getBottomInventory = null;
+		if (!InventoryView.class.isInterface()) { // initialize legacy support as it's likely an abstract class
+			try {
+				MethodHandles.Lookup lookup = MethodHandles.lookup();
+				getTitle = lookup.findVirtual(InventoryView.class, "getTitle", MethodType.methodType(String.class));
+				getInventory = lookup.findVirtual(InventoryView.class, "getInventory", MethodType.methodType(Inventory.class, int.class));
+				convertSlot = lookup.findVirtual(InventoryView.class, "convertSlot", MethodType.methodType(int.class, int.class));
+				getTopInventory = lookup.findVirtual(InventoryView.class, "getTopInventory", MethodType.methodType(Inventory.class));
+				getBottomInventory = lookup.findVirtual(InventoryView.class, "getBottomInventory", MethodType.methodType(Inventory.class));
+			} catch (NoSuchMethodException | IllegalAccessException e) {
+				Skript.exception(e, "Failed to load old inventory view support.");
+			}
+		}
+		GET_TITLE = getTitle;
+		GET_INVENTORY = getInventory;
+		CONVERT_SLOT = convertSlot;
+		GET_TOP_INVENTORY = getTopInventory;
+		GET_BOTTOM_INVENTORY = getBottomInventory;
+	}
+
+	/**
+	 * @see InventoryView#getTitle()
+	 */
+	public static @Nullable String getTitle(InventoryView inventoryView) {
+		if (GET_TITLE == null)
+			return inventoryView.getTitle();
+		try {
+			return (String) GET_TITLE.invoke(inventoryView);
+		} catch (Throwable ignored) { }
+		return null;
+	}
+
+	/**
+	 * @see InventoryView#getInventory(int)
+	 */
+	public static @Nullable Inventory getInventory(InventoryView inventoryView, int rawSlot) {
+		if (GET_INVENTORY == null)
+			return inventoryView.getInventory(rawSlot);
+		try {
+			return (Inventory) GET_INVENTORY.invoke(inventoryView, rawSlot);
+		} catch (Throwable ignored) { }
+		return null;
+	}
+
+	/**
+	 * @see InventoryView#convertSlot(int)
+	 */
+	public static @Nullable Integer convertSlot(InventoryView inventoryView, int rawSlot) {
+		if (CONVERT_SLOT == null)
+			return inventoryView.convertSlot(rawSlot);
+		try {
+			return (Integer) CONVERT_SLOT.invoke(inventoryView, rawSlot);
+		} catch (Throwable ignored) { }
+		return null;
+	}
+
+	/**
+	 * @see InventoryView#getTopInventory()
+	 */
+	public static @Nullable Inventory getTopInventory(InventoryView inventoryView) {
+		if (GET_TOP_INVENTORY == null)
+			return inventoryView.getTopInventory();
+		try {
+			return (Inventory) GET_TOP_INVENTORY.invoke(inventoryView);
+		} catch (Throwable ignored) { }
+		return null;
+	}
+
+	/**
+	 * @see InventoryView#getBottomInventory()
+	 */
+	public static @Nullable Inventory getBottomInventory(InventoryView inventoryView) {
+		if (GET_BOTTOM_INVENTORY == null)
+			return inventoryView.getBottomInventory();
+		try {
+			return (Inventory) GET_BOTTOM_INVENTORY.invoke(inventoryView);
+		} catch (Throwable ignored) { }
+		return null;
+	}
+
+}

src/main/java/ch/njol/skript/bukkitutil/ItemUtils.java

@@ -105,7 +105,7 @@ public static void setMaxDamage(ItemStack itemStack, int maxDamage) {
 	public static void setDamage(ItemStack itemStack, int damage) {
 		ItemMeta meta = itemStack.getItemMeta();
 		if (meta instanceof Damageable) {
-			((Damageable) meta).setDamage(damage);
+			((Damageable) meta).setDamage(Math.max(0, damage));
 			itemStack.setItemMeta(meta);
 		}
 	}

src/main/java/ch/njol/skript/bukkitutil/block/NewBlockCompat.java

@@ -349,7 +349,7 @@ public BlockValues getBlockValues(BlockState blockState) {
 	@Override
 	public @Nullable BlockValues getBlockValues(Material material) {
 		if (material.isBlock())
-			return new NewBlockValues(material, Bukkit.createBlockData(material), false);
+			return new NewBlockValues(material, Bukkit.createBlockData(material), true);
 		return null;
 	}
 

src/main/java/ch/njol/skript/classes/data/BukkitClasses.java

@@ -949,7 +949,10 @@ public ItemStack parse(final String s, final ParseContext context) {
 						}
 
 						final ItemStack i = t.getRandom();
-						assert i != null;
+						if (i == null) {
+							Skript.error("'" + s + "' cannot represent an item");
+							return null;
+						}
 						return i;
 					}
 
@@ -1409,7 +1412,8 @@ public String toVariableNameString(FireworkEffect effect) {
 			if (BukkitUtils.registryExists("CAT_VARIANT")) {
 				catTypeClassInfo = new RegistryClassInfo<>(Cat.Type.class, Registry.CAT_VARIANT, "cattype", "cat types");
 			} else {
-				catTypeClassInfo = new EnumClassInfo<>(Cat.Type.class, "cattype", "cat types");
+				//noinspection unchecked, rawtypes - it is an enum on other versions
+				catTypeClassInfo = new EnumClassInfo<>((Class) Cat.Type.class, "cattype", "cat types");
 			}
 			Classes.registerClass(catTypeClassInfo
 					.user("cat ?(type|race)s?")

src/main/java/ch/njol/skript/classes/data/BukkitEventValues.java

@@ -26,6 +26,7 @@
 import ch.njol.skript.Skript;
 import ch.njol.skript.aliases.Aliases;
 import ch.njol.skript.aliases.ItemType;
+import ch.njol.skript.bukkitutil.InventoryUtils;
 import ch.njol.skript.command.CommandEvent;
 import ch.njol.skript.events.bukkit.ScriptEvent;
 import ch.njol.skript.events.bukkit.SkriptStartEvent;
@@ -1252,15 +1253,15 @@ public Slot[] get(InventoryDragEvent event) {
 				List<Slot> slots = new ArrayList<>(event.getRawSlots().size());
 				InventoryView view = event.getView();
 				for (Integer rawSlot : event.getRawSlots()) {
-					Inventory inventory = view.getInventory(rawSlot);
-					int slot = view.convertSlot(rawSlot);
-					if (inventory == null)
+					Inventory inventory = InventoryUtils.getInventory(view, rawSlot);
+					Integer slot = InventoryUtils.convertSlot(view, rawSlot);
+					if (inventory == null || slot == null)
 						continue;
 					// Not all indices point to inventory slots. Equipment, for example
 					if (inventory instanceof PlayerInventory && slot >= 36) {
 						slots.add(new ch.njol.skript.util.slot.EquipmentSlot(((PlayerInventory) view.getBottomInventory()).getHolder(), slot));
 					} else {
-						slots.add(new InventorySlot(inventory, view.convertSlot(rawSlot)));
+						slots.add(new InventorySlot(inventory, slot));
 					}
 				}
 				return slots.toArray(new Slot[0]);
@@ -1280,7 +1281,9 @@ public Inventory[] get(InventoryDragEvent event) {
 				Set<Inventory> inventories = new HashSet<>();
 				InventoryView view = event.getView();
 				for (Integer rawSlot : event.getRawSlots()) {
-					inventories.add(view.getInventory(rawSlot));
+					Inventory inventory = InventoryUtils.getInventory(view, rawSlot);
+					if (inventory != null)
+						inventories.add(inventory);
 				}
 				return inventories.toArray(new Inventory[0]);
 			}

src/main/java/ch/njol/skript/classes/registry/RegistrySerializer.java

@@ -43,27 +43,27 @@ public RegistrySerializer(Registry<R> registry) {
 	@Override
 	public @NotNull Fields serialize(R o) {
 		Fields fields = new Fields();
-		fields.putPrimitive("name", o.getKey().toString());
+		fields.putObject("name", o.getKey().toString());
 		return fields;
 	}
 
 	@Override
-	protected R deserialize(Fields fields) {
-		try {
-			String name = fields.getAndRemovePrimitive("name", String.class);
-			NamespacedKey namespacedKey;
-			if (!name.contains(":")) {
-				// Old variables
-				namespacedKey = NamespacedKey.minecraft(name);
-			} else {
-				namespacedKey = NamespacedKey.fromString(name);
-			}
-			if (namespacedKey == null)
-				return null;
-			return registry.get(namespacedKey);
-		} catch (StreamCorruptedException e) {
-			return null;
+	protected R deserialize(Fields fields) throws StreamCorruptedException {
+		String name = fields.getAndRemoveObject("name", String.class);
+		assert name != null;
+		NamespacedKey namespacedKey;
+		if (!name.contains(":")) {
+			// Old variables
+			namespacedKey = NamespacedKey.minecraft(name);
+		} else {
+			namespacedKey = NamespacedKey.fromString(name);
 		}
+		if (namespacedKey == null)
+			throw new StreamCorruptedException("Invalid namespacedkey: " + name);
+		R object = registry.get(namespacedKey);
+		if (object == null)
+			throw new StreamCorruptedException("Invalid object from registry: " + namespacedKey);
+		return object;
 	}
 
 	@Override

src/main/java/ch/njol/skript/conditions/CondIsPreferredTool.java

@@ -80,13 +80,14 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 	public boolean check(Event event) {
 		return blocks.check(event, block ->
 			items.check(event, item -> {
-				if (block instanceof Block) {
-					return ((Block) block).isPreferredTool(item.getRandom());
-				} else if (block instanceof BlockData) {
-					return ((BlockData) block).isPreferredTool(item.getRandom());
-				} else {
-					return false;
+				ItemStack stack = item.getRandom();
+				if (stack != null) {
+					if (block instanceof Block)
+						return ((Block) block).isPreferredTool(stack);
+					if (block instanceof BlockData)
+						return ((BlockData) block).isPreferredTool(stack);
 				}
+				return false;
 			}), isNegated());
 	}
 

src/main/java/ch/njol/skript/effects/EffBroadcast.java

@@ -86,7 +86,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 	}
 
 	/**
-	 * This effect will call {@link BroadcastMessageEvent} as of INSERT_VERSION.
+	 * This effect will call {@link BroadcastMessageEvent} as of 2.9.0.
 	 */
 	@Override
 	@SuppressWarnings("deprecation")

src/main/java/ch/njol/skript/effects/EffOpenBook.java

@@ -68,7 +68,7 @@ protected void execute(final Event e) {
 		ItemType itemType = book.getSingle(e);
 		if (itemType != null) {
 			ItemStack itemStack = itemType.getRandom();
-			if (itemStack.getType() == Material.WRITTEN_BOOK) {
+			if (itemStack != null && itemStack.getType() == Material.WRITTEN_BOOK) {
 				for (Player player : players.getArray(e)) {
 					player.openBook(itemStack);
 				}

src/main/java/ch/njol/skript/effects/EffReplace.java

@@ -129,9 +129,10 @@ private void replace(Event event, Object[] needles, Expression<?> haystackExpr)
 
 						if (new ItemType(itemStack).isSimilar(needle)) {
 							ItemStack newItemStack = ((ItemType) replacement).getRandom();
-							newItemStack.setAmount(itemStack.getAmount());
-
-							inv.setItem(slot, newItemStack);
+							if (newItemStack != null) {
+								newItemStack.setAmount(itemStack.getAmount());
+								inv.setItem(slot, newItemStack);
+							}
 						}
 					}
 		}

src/main/java/ch/njol/skript/effects/EffReturn.java

@@ -19,7 +19,6 @@
 package ch.njol.skript.effects;
 
 import ch.njol.skript.Skript;
-import ch.njol.skript.classes.ClassInfo;
 import ch.njol.skript.doc.Description;
 import ch.njol.skript.doc.Examples;
 import ch.njol.skript.doc.Name;
@@ -110,7 +109,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 	protected TriggerItem walk(Event event) {
 		debug(event, false);
 		//noinspection rawtypes,unchecked
-		((ReturnHandler) handler).returnValues(value.getArray(event));
+		((ReturnHandler) handler).returnValues(event, value);
 
 		TriggerSection parent = getParent();
 		while (parent != null && parent != handler) {

src/main/java/ch/njol/skript/entity/BoatChestData.java

@@ -110,8 +110,7 @@ public boolean isSupertypeOf(EntityData<?> e) {
 	public boolean isOfItemType(ItemType itemType) {
 		int ordinal = -1;
 
-		ItemStack stack = itemType.getRandom();
-		Material type = stack.getType();
+		Material type = itemType.getMaterial();
 		if (type == Material.OAK_CHEST_BOAT)
 			ordinal = 0;
 		else if (type == Material.SPRUCE_CHEST_BOAT)

src/main/java/ch/njol/skript/entity/BoatData.java

@@ -112,9 +112,8 @@ public boolean isSupertypeOf(EntityData<?> e) {
 
 	public boolean isOfItemType(ItemType i){
 		int ordinal = -1;
-
-		ItemStack stack = i.getRandom();
-		Material type = stack.getType();
+
+		Material type = i.getMaterial();
 		if (type == Material.OAK_BOAT)
 			ordinal = 0;
 		else if (type == Material.SPRUCE_BOAT)