Merge branch 'dev/feature' into feature/preinit

Author: sovdeeth

gradle.properties

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

skript-aliases

@@ -1002,14 +1002,15 @@ public static ArrayList<TriggerItem> loadItems(SectionNode node) {
 						break find_section;
 					Collection<LogEntry> errors = handler.getErrors();
 
-					// restore the failure log
-					if (errors.isEmpty()) {
+					// restore the failure log if:
+					// 1. there are no errors from the statement parse
+					// 2. the error message is the default one from the statement parse
+					// 3. the backup log contains a message about the section being claimed
+					if (errors.isEmpty()
+						|| errors.iterator().next().getMessage().contains("Can't understand this condition/effect:")
+						|| backup.getErrors().iterator().next().getMessage().contains("tried to claim the current section, but it was already claimed by")
+					) {
 						handler.restore(backup);
-					} else { // We specifically want these two errors in preference to the section error!
-						String firstError = errors.iterator().next().getMessage();
-						if (!firstError.contains("is a valid statement but cannot function as a section (:)")
-							&& !firstError.contains("You cannot have two section-starters in the same line"))
-							handler.restore(backup);
 					}
 					continue;
 				} finally {

src/main/java/ch/njol/skript/ScriptLoader.java

@@ -564,7 +564,7 @@ public boolean matchPlain(ItemData other) {
 	@Override
 	public Fields serialize() throws NotSerializableException {
 		Fields fields = new Fields(this); // ItemStack is transient, will be ignored
-		fields.putPrimitive("id", type.ordinal());
+		fields.putObject("key", type.getKey().toString());
 		fields.putObject("meta", stack != null ? stack.getItemMeta() : null);
 		return fields;
 	}
@@ -573,7 +573,16 @@ public Fields serialize() throws NotSerializableException {
 
 	@Override
 	public void deserialize(Fields fields) throws StreamCorruptedException, NotSerializableException {
-		this.type = materials[fields.getAndRemovePrimitive("id", int.class)];
+		if (fields.hasField("key")) {
+			String key = fields.getAndRemoveObject("key", String.class);
+			if (key == null)
+				throw new StreamCorruptedException("Material key is null");
+			this.type = Material.matchMaterial(key);
+		} else {
+			// attempt back compat deserialization, though using ordinals is not reliable
+			this.type = materials[fields.getAndRemovePrimitive("id", int.class)];
+		}
+
 		ItemMeta meta = fields.getAndRemoveObject("meta", ItemMeta.class);
 
 		// Initialize ItemStack

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

@@ -21,11 +21,7 @@
 import ch.njol.yggdrasil.Fields;
 import ch.njol.yggdrasil.Fields.FieldContext;
 import ch.njol.yggdrasil.YggdrasilSerializable.YggdrasilExtendedSerializable;
-import org.bukkit.Location;
-import org.bukkit.Material;
-import org.bukkit.OfflinePlayer;
-import org.bukkit.Tag;
-import org.bukkit.Bukkit;
+import org.bukkit.*;
 import org.bukkit.block.Block;
 import org.bukkit.block.BlockState;
 import org.bukkit.block.Skull;
@@ -35,6 +31,7 @@
 import org.bukkit.inventory.Inventory;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.PlayerInventory;
+import org.bukkit.inventory.meta.BlockStateMeta;
 import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.inventory.meta.SkullMeta;
 import org.jetbrains.annotations.NotNull;
@@ -43,19 +40,8 @@
 import java.io.NotSerializableException;
 import java.io.StreamCorruptedException;
 import java.lang.reflect.Field;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.Map.Entry;
-import java.util.NoSuchElementException;
-import java.util.Random;
-import java.util.RandomAccess;
-import java.util.Set;
 import java.util.stream.Collectors;
 
 @ContainerType(ItemStack.class)
@@ -390,8 +376,8 @@ public boolean setBlock(Block block, boolean applyPhysics) {
 
 			ItemMeta itemMeta = getItemMeta();
 
-			if (itemMeta instanceof SkullMeta) {
-				OfflinePlayer offlinePlayer = ((SkullMeta) itemMeta).getOwningPlayer();
+			if (itemMeta instanceof SkullMeta skullMeta) {
+				OfflinePlayer offlinePlayer = skullMeta.getOwningPlayer();
 				if (offlinePlayer == null)
 					continue;
 				Skull skull = (Skull) block.getState();
@@ -407,11 +393,49 @@ public boolean setBlock(Block block, boolean applyPhysics) {
 				skull.update(false, applyPhysics);
 			}
 
+			// https://github.com/SkriptLang/Skript/issues/7735
+			// No method exists to copy general BlockStateMeta data to a block, so we have to do it manually for now
+			copyContainerState(block, itemMeta);
+
 			return true;
 		}
 		return false;
 	}
 
+	/**
+	 * Copies the container state from the item meta to the block state
+	 * @param block The block to copy the state to
+	 * @param itemMeta The item meta to copy the state from
+	 */
+	private void copyContainerState(@NotNull Block block, @NotNull ItemMeta itemMeta) {
+		// ensure the item has a block state
+		if (!(itemMeta instanceof BlockStateMeta blockStateMeta) || !blockStateMeta.hasBlockState())
+			return;
+
+		// only care about container -> container copying
+		if (!(blockStateMeta.getBlockState() instanceof org.bukkit.block.Container itemContainer)
+				|| !(block.getState() instanceof org.bukkit.block.Container blockContainer))
+			return;
+
+		// copy inventory from item to block
+		copyInventories(itemContainer.getSnapshotInventory(), blockContainer.getSnapshotInventory());
+		blockContainer.update();
+	}
+
+	/**
+	 * Copies the contents of one inventory to another, maintaining slot positions and making clones.
+	 * @param from The inventory to copy from
+	 * @param to The inventory to copy to
+	 */
+	private void copyInventories(@NotNull Inventory from, @NotNull Inventory to) {
+		for (int i = 0; i < from.getSize(); i++) {
+			ItemStack item = from.getItem(i);
+			if (item != null) {
+				to.setItem(i, item.clone());
+			}
+		}
+	}
+
 	/**
 	 * Send a block change to a player
 	 * <p>This will send a fake block change to the player, and will not change the block on the server.</p>

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

@@ -1,7 +1,10 @@
 package ch.njol.skript.bukkitutil;
 
 import ch.njol.skript.Skript;
+import com.google.common.collect.BiMap;
+import com.google.common.collect.HashBiMap;
 import org.bukkit.Registry;
+import org.bukkit.inventory.EquipmentSlot;
 import org.bukkit.potion.PotionEffectType;
 import org.jetbrains.annotations.Nullable;
 
@@ -10,6 +13,16 @@
  */
 public class BukkitUtils {
 
+	private static final BiMap<EquipmentSlot, Integer> BUKKIT_EQUIPMENT_SLOT_INDICES = HashBiMap.create();
+
+	static {
+		BUKKIT_EQUIPMENT_SLOT_INDICES.put(EquipmentSlot.FEET, 36);
+		BUKKIT_EQUIPMENT_SLOT_INDICES.put(EquipmentSlot.LEGS, 37);
+		BUKKIT_EQUIPMENT_SLOT_INDICES.put(EquipmentSlot.CHEST, 38);
+		BUKKIT_EQUIPMENT_SLOT_INDICES.put(EquipmentSlot.HEAD, 39);
+		BUKKIT_EQUIPMENT_SLOT_INDICES.put(EquipmentSlot.OFF_HAND, 40);
+	}
+
 	/**
 	 * Check if a registry exists
 	 *
@@ -36,4 +49,22 @@ public static boolean registryExists(String registry) {
 		return null;
 	}
 
+	/**
+	 * Get the inventory slot index of the {@link EquipmentSlot}
+	 * @param equipmentSlot The equipment slot to get the index of
+	 * @return The equipment slot index of the provided slot, otherwise null if invalid
+	 */
+	public static Integer getEquipmentSlotIndex(EquipmentSlot equipmentSlot) {
+		return  BUKKIT_EQUIPMENT_SLOT_INDICES.get(equipmentSlot);
+	}
+
+	/**
+	 * Get the {@link EquipmentSlot} represented by the inventory slot index
+	 * @param slotIndex The index of the equipment slot
+	 * @return The equipment slot the provided slot index, otherwise null if invalid
+	 */
+	public static EquipmentSlot getEquipmentSlotFromIndex(int slotIndex) {
+		return BUKKIT_EQUIPMENT_SLOT_INDICES.inverse().get(slotIndex);
+	}
+
 }

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

@@ -1424,7 +1424,7 @@ public String toVariableNameString(EnchantmentOffer eo) {
 			.name("Wolf Variant")
 			.description("Represents the variant of a wolf entity.",
 				"NOTE: Minecraft namespaces are supported, ex: 'minecraft:ashen'.")
-			.since("@VERSION")
+			.since("2.10")
 			.requiredPlugins("Minecraft 1.21+")
 			.documentationId("WolfVariant"));
 

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

@@ -764,6 +764,21 @@ else if (hand == EquipmentSlot.OFF_HAND)
 			EventValues.registerEventValue(WorldBorderCenterChangeEvent.class, Location.class, WorldBorderCenterChangeEvent::getNewCenter);
 			EventValues.registerEventValue(WorldBorderCenterChangeEvent.class, Location.class, WorldBorderCenterChangeEvent::getOldCenter, EventValues.TIME_PAST);
 		}
+
+		if (Skript.classExists("org.bukkit.event.block.VaultDisplayItemEvent")) {
+			EventValues.registerEventValue(VaultDisplayItemEvent.class, ItemStack.class, new EventConverter<>() {
+				@Override
+				public void set(VaultDisplayItemEvent event, @Nullable ItemStack itemStack) {
+					event.setDisplayItem(itemStack);
+				}
+
+				@Override
+				public @Nullable ItemStack convert(VaultDisplayItemEvent event) {
+					return event.getDisplayItem();
+				}
+			});
+		}
+
 	}
 
 }

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

@@ -36,7 +36,7 @@ public class JSONGenerator extends DocumentationGenerator {
 	/**
 	 * The current version of the JSON generator
 	 */
-	public static final Version JSON_VERSION = new Version(1, 0);
+	public static final Version JSON_VERSION = new Version(1, 1);
 
 	private static final Gson GSON = new GsonBuilder()
 		.disableHtmlEscaping()
@@ -200,6 +200,10 @@ private static JsonArray getEventValues(SkriptEventInfo<?> info) {
 			}
 		}
 
+		if (eventValues.isEmpty()) {
+			return null;
+		}
+
 		JsonArray array = new JsonArray();
 		for (JsonObject eventValue : eventValues) {
 			array.add(eventValue);

src/main/java/ch/njol/skript/doc/JSONGenerator.java

@@ -10,16 +10,19 @@
 import ch.njol.skript.util.Utils;
 import ch.njol.skript.util.slot.Slot;
 import com.destroystokyo.paper.event.player.PlayerArmorChangeEvent;
+import com.destroystokyo.paper.event.player.PlayerArmorChangeEvent.SlotType;
 import org.bukkit.event.Event;
 import org.bukkit.inventory.EquipmentSlot;
 import org.bukkit.inventory.ItemStack;
 import org.jetbrains.annotations.Nullable;
+import org.skriptlang.skript.lang.converter.Converter;
 
-import java.util.concurrent.CompletionException;
+import java.util.Map;
 
 public class EvtPlayerArmorChange extends SkriptEvent {
 
-	private static boolean BODY_SLOT_EXISTS;
+	private static final boolean BODY_SLOT_EXISTS = Skript.fieldExists(EquipmentSlot.class, "BODY");
+	private static Converter<PlayerArmorChangeEvent, EquipmentSlot> GET_SLOT;
 
 	static {
 		if (Skript.classExists("com.destroystokyo.paper.event.player.PlayerArmorChangeEvent")) {
@@ -36,22 +39,30 @@ public class EvtPlayerArmorChange extends SkriptEvent {
 				)
 				.since("2.5, 2.11 (equipment slots)");
 
-			EquipmentSlot bodySlot = null;
-			try {
-				bodySlot = EquipmentSlot.valueOf("BODY");
-			} catch (IllegalArgumentException | NoSuchFieldError | CompletionException ignored) {};
-			BODY_SLOT_EXISTS = bodySlot != null;
+			// get slot function is dependent on version. 1.21.4+ has a new method.
+			if (Skript.methodExists(PlayerArmorChangeEvent.class, "getSlot")) {
+				GET_SLOT = PlayerArmorChangeEvent::getSlot;
+			} else {
+				//noinspection deprecation
+				Map<SlotType, EquipmentSlot> slotTypeMap = Map.of(
+					Enum.valueOf(SlotType.class, "HEAD"), EquipmentSlot.HEAD,
+					Enum.valueOf(SlotType.class, "CHEST"), EquipmentSlot.CHEST,
+					Enum.valueOf(SlotType.class, "LEGS"), EquipmentSlot.LEGS,
+					Enum.valueOf(SlotType.class, "FEET"), EquipmentSlot.FEET);
+				GET_SLOT = event -> {
+					//noinspection deprecation
+					return slotTypeMap.get(event.getSlotType());
+				};
+			}
 
-			EventValues.registerEventValue(PlayerArmorChangeEvent.class, EquipmentSlot.class,
-				event -> switch (event.getSlotType()) {
-					case HEAD -> EquipmentSlot.HEAD;
-					case CHEST -> EquipmentSlot.CHEST;
-					case LEGS -> EquipmentSlot.LEGS;
-					case FEET -> EquipmentSlot.FEET;
-				});
-			EventValues.registerEventValue(PlayerArmorChangeEvent.class, ItemStack.class, PlayerArmorChangeEvent::getOldItem, EventValues.TIME_PAST);
-			EventValues.registerEventValue(PlayerArmorChangeEvent.class, ItemStack.class, PlayerArmorChangeEvent::getNewItem, EventValues.TIME_FUTURE);
-			EventValues.registerEventValue(PlayerArmorChangeEvent.class, Slot.class, event -> new ch.njol.skript.util.slot.EquipmentSlot(event.getPlayer().getEquipment(), event.getSlot()));
+			// Register event values
+			EventValues.registerEventValue(PlayerArmorChangeEvent.class, EquipmentSlot.class, GET_SLOT);
+			EventValues.registerEventValue(PlayerArmorChangeEvent.class, ItemStack.class,
+					PlayerArmorChangeEvent::getOldItem, EventValues.TIME_PAST);
+			EventValues.registerEventValue(PlayerArmorChangeEvent.class, ItemStack.class,
+					PlayerArmorChangeEvent::getNewItem, EventValues.TIME_FUTURE);
+			EventValues.registerEventValue(PlayerArmorChangeEvent.class, Slot.class,
+					event -> new ch.njol.skript.util.slot.EquipmentSlot(event.getPlayer().getEquipment(), event.getSlot()));
 		}
 	}
 
@@ -76,13 +87,7 @@ public boolean check(Event event) {
 		PlayerArmorChangeEvent changeEvent = (PlayerArmorChangeEvent) event;
 		if (slot == null)
 			return true;
-		EquipmentSlot changedSlot = switch (changeEvent.getSlotType()) {
-			case HEAD -> EquipmentSlot.HEAD;
-			case CHEST -> EquipmentSlot.CHEST;
-			case LEGS -> EquipmentSlot.LEGS;
-			case FEET -> EquipmentSlot.FEET;
-		};
-		return slot == changedSlot;
+		return slot == GET_SLOT.convert(changeEvent);
 	}
 
 	@Override