Tool Components

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

@@ -3,39 +3,53 @@
 import ch.njol.skript.aliases.Aliases;
 import ch.njol.skript.bukkitutil.BurgerHelper;
 import ch.njol.skript.classes.ClassInfo;
-import ch.njol.skript.classes.data.*;
+import ch.njol.skript.classes.data.BukkitClasses;
+import ch.njol.skript.classes.data.BukkitEventValues;
+import ch.njol.skript.classes.data.DefaultComparators;
+import ch.njol.skript.classes.data.DefaultConverters;
+import ch.njol.skript.classes.data.DefaultFunctions;
+import ch.njol.skript.classes.data.DefaultOperations;
+import ch.njol.skript.classes.data.JavaClasses;
+import ch.njol.skript.classes.data.SkriptClasses;
 import ch.njol.skript.command.Commands;
 import ch.njol.skript.doc.Documentation;
 import ch.njol.skript.events.EvtSkript;
 import ch.njol.skript.hooks.Hook;
 import ch.njol.skript.lang.*;
-import ch.njol.skript.lang.Effect;
-import ch.njol.skript.lang.Expression;
-import ch.njol.skript.lang.ExpressionInfo;
-import ch.njol.skript.lang.ExpressionType;
-import ch.njol.skript.lang.Section;
-import ch.njol.skript.lang.SkriptEvent;
-import ch.njol.skript.lang.SkriptEventInfo;
-import ch.njol.skript.lang.Statement;
-import ch.njol.skript.lang.SyntaxElementInfo;
-import ch.njol.skript.lang.Trigger;
-import ch.njol.skript.lang.TriggerItem;
 import ch.njol.skript.lang.Condition.ConditionType;
 import ch.njol.skript.lang.util.SimpleExpression;
 import ch.njol.skript.localization.Language;
 import ch.njol.skript.localization.Message;
 import ch.njol.skript.localization.PluralizingArgsMessage;
-import ch.njol.skript.log.*;
+import ch.njol.skript.log.BukkitLoggerFilter;
+import ch.njol.skript.log.CountingLogHandler;
+import ch.njol.skript.log.ErrorDescLogHandler;
+import ch.njol.skript.log.ErrorQuality;
+import ch.njol.skript.log.LogEntry;
+import ch.njol.skript.log.LogHandler;
+import ch.njol.skript.log.SkriptLogger;
+import ch.njol.skript.log.TestingLogHandler;
+import ch.njol.skript.log.Verbosity;
 import ch.njol.skript.registrations.Classes;
 import ch.njol.skript.registrations.EventValues;
 import ch.njol.skript.registrations.Feature;
-import ch.njol.skript.test.runner.*;
+import ch.njol.skript.test.runner.EffObjectives;
+import ch.njol.skript.test.runner.SkriptAsyncJUnitTest;
+import ch.njol.skript.test.runner.SkriptJUnitTest;
+import ch.njol.skript.test.runner.SkriptTestEvent;
+import ch.njol.skript.test.runner.TestMode;
+import ch.njol.skript.test.runner.TestTracker;
 import ch.njol.skript.timings.SkriptTimings;
 import ch.njol.skript.update.ReleaseManifest;
 import ch.njol.skript.update.ReleaseStatus;
 import ch.njol.skript.update.UpdateManifest;
 import ch.njol.skript.util.Date;
-import ch.njol.skript.util.*;
+import ch.njol.skript.util.EmptyStacktraceException;
+import ch.njol.skript.util.ExceptionUtils;
+import ch.njol.skript.util.FileUtils;
+import ch.njol.skript.util.Task;
+import ch.njol.skript.util.Utils;
+import ch.njol.skript.util.Version;
 import ch.njol.skript.util.chat.BungeeConverter;
 import ch.njol.skript.util.chat.ChatMessages;
 import ch.njol.skript.variables.Variables;
@@ -48,7 +62,11 @@
 import com.google.gson.GsonBuilder;
 import io.papermc.lib.PaperLib;
 import org.bstats.bukkit.Metrics;
-import org.bukkit.*;
+import org.bukkit.Bukkit;
+import org.bukkit.ChatColor;
+import org.bukkit.Material;
+import org.bukkit.OfflinePlayer;
+import org.bukkit.Server;
 import org.bukkit.command.CommandSender;
 import org.bukkit.command.PluginCommand;
 import org.bukkit.entity.Player;
@@ -77,6 +95,7 @@
 import org.skriptlang.skript.bukkit.fishing.FishingModule;
 import org.skriptlang.skript.bukkit.furnace.FurnaceModule;
 import org.skriptlang.skript.bukkit.input.InputModule;
+import org.skriptlang.skript.bukkit.itemcomponents.ItemComponentModule;
 import org.skriptlang.skript.bukkit.log.runtime.BukkitRuntimeErrorConsumer;
 import org.skriptlang.skript.bukkit.loottables.LootTableModule;
 import org.skriptlang.skript.bukkit.registration.BukkitRegistryKeys;
@@ -396,8 +415,7 @@ public void onEnable() {
 		File config = new File(getDataFolder(), "config.sk");
 		File features = new File(getDataFolder(), "features.sk");
 		File lang = new File(getDataFolder(), "lang");
-		File aliasesFolder = new File(getDataFolder(), "aliases");
-		if (!scriptsFolder.isDirectory() || !config.exists() || !features.exists() || !lang.exists() || !aliasesFolder.exists()) {
+		if (!scriptsFolder.isDirectory() || !config.exists() || !features.exists() || !lang.exists()) {
 			ZipFile f = null;
 			try {
 				boolean populateExamples = false;
@@ -414,11 +432,6 @@ public void onEnable() {
 					populateLanguageFiles = true;
 				}
 
-				if (!aliasesFolder.isDirectory()) {
-					if (!aliasesFolder.mkdirs())
-						throw new IOException("Could not create the directory " + aliasesFolder);
-				}
-
 				f = new ZipFile(getFile());
 				for (ZipEntry e : new EnumerationIterable<ZipEntry>(f.entries())) {
 					if (e.isDirectory())
@@ -566,6 +579,7 @@ public void onEnable() {
 			TagModule.load();
 			FurnaceModule.load();
 			LootTableModule.load();
+			skript.loadModules(new ItemComponentModule());
 		} catch (final Exception e) {
 			exception(e, "Could not load required .class files: " + e.getLocalizedMessage());
 			setEnabled(false);

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

@@ -401,8 +401,9 @@ public static void setItemMeta(Object object, @NotNull ItemMeta itemMeta) {
 			itemType.setItemMeta(itemMeta);
 		} else if (object instanceof ItemStack itemStack) {
 			itemStack.setItemMeta(itemMeta);
+		} else {
+			throw new IllegalArgumentException("Object was not a Slot, ItemType or ItemStack.");
 		}
-		throw new IllegalArgumentException("Object was not a Slot, ItemType or ItemStack.");
 	}
 
 }

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

@@ -0,0 +1,92 @@
+package ch.njol.skript.bukkitutil;
+
+import ch.njol.skript.localization.ArgsMessage;
+import ch.njol.skript.localization.Message;
+import ch.njol.skript.util.ValidationResult;
+import org.bukkit.NamespacedKey;
+
+/**
+ * Utility class for {@link NamespacedKey}
+ */
+public class NamespacedUtils {
+
+	public static final Message NAMEDSPACED_FORMAT_MESSAGE =
+		new ArgsMessage("misc.namespacedutils.format");
+
+	/**
+	 * Check if {@code character} is a valid {@link Character} for the namespace section of a {@link NamespacedKey}.
+	 * @param character The {@link Character} to check.
+	 * @return {@code True} if valid, otherwise {@code false}.
+	 */
+	public static boolean isValidNamespaceChar(char character) {
+		return (character >= 'a' && character <= 'z') || (character >= '0' && character <= '9') || character == '.' || character == '_' || character == '-';
+	}
+
+	/**
+	 * Check if {@code character} is a valid {@link Character} for the key section of a {@link NamespacedKey}.
+	 * @param character The {@link Character} to check.
+	 * @return {@code True} if valid, otherwise {@code false}.
+	 */
+	public static boolean isValidKeyChar(char character) {
+		return isValidNamespaceChar(character) || character == '/';
+	}
+
+	/**
+	 * Check if the {@code string} is valid for a {@link NamespacedKey} and get a {@link ValidationResult}
+	 * containing if it's valid, an error or warning message and the resulting {@link NamespacedKey}.
+	 * @param string The {@link String} to check.
+	 * @return {@link ValidationResult}.
+	 */
+	public static ValidationResult<NamespacedKey> checkValidation(String string) {
+		if (string.length() > Short.MAX_VALUE)
+			return new ValidationResult<>(false, "A namespaced key can not be longer than " + Short.MAX_VALUE + " characters.");
+		String[] split = string.split(":");
+		if (split.length > 2)
+			return new ValidationResult<>(false, "A namespaced key can not have more than one ':'.");
+
+		String key = split.length == 2 ? split[1] : split[0];
+		if (key.isEmpty())
+			return new ValidationResult<>(false, "The key cannot be empty.");
+		for (char character : key.toCharArray()) {
+			if (!isValidKeyChar(character)) {
+				return new ValidationResult<>(false, "Invalid character '" + character + "'.");
+			}
+		}
+
+		NamespacedKey namespacedKey;
+		boolean emptyNamespace = false;
+		if (split.length == 2) {
+			String namespace = split[0];
+			if (!namespace.isEmpty()) {
+				for (char character : namespace.toCharArray()) {
+					if (!isValidNamespaceChar(character)) {
+						return new ValidationResult<>(false, "Invalid character '" + character + "'.");
+					}
+				}
+				namespacedKey = new NamespacedKey(namespace, key);
+			} else {
+				emptyNamespace = true;
+				namespacedKey = NamespacedKey.minecraft(key);
+			}
+		} else {
+			namespacedKey = NamespacedKey.minecraft(key);
+		}
+
+		if (emptyNamespace)
+			return new ValidationResult<>(
+				true,
+				"The namespace section of the key is empty. Consider removing the ':'.",
+				namespacedKey);
+		return new ValidationResult<>(true, namespacedKey);
+	}
+
+	/**
+	 * Check if {@code string} is valid for a {@link NamespacedKey}.
+	 * @param string The {@link String} to check.
+	 * @return {@code True} if valid, otherwise {@code false}.
+	 */
+	public static boolean isValid(String string) {
+		return checkValidation(string).valid();
+	}
+
+}

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

@@ -10,17 +10,7 @@
 import ch.njol.skript.entity.BoatData;
 import ch.njol.skript.entity.EntityData;
 import ch.njol.skript.entity.RabbitData;
-import ch.njol.skript.util.BlockUtils;
-import ch.njol.skript.util.Color;
-import ch.njol.skript.util.Date;
-import ch.njol.skript.util.EnchantmentType;
-import ch.njol.skript.util.Experience;
-import ch.njol.skript.util.GameruleValue;
-import ch.njol.skript.util.StructureType;
-import ch.njol.skript.util.Time;
-import ch.njol.skript.util.Timeperiod;
-import ch.njol.skript.util.Timespan;
-import ch.njol.skript.util.WeatherType;
+import ch.njol.skript.util.*;
 import ch.njol.skript.util.slot.EquipmentSlot;
 import ch.njol.skript.util.slot.Slot;
 import ch.njol.skript.util.slot.SlotWithIndex;
@@ -34,7 +24,12 @@
 import org.bukkit.block.data.BlockData;
 import org.bukkit.command.CommandSender;
 import org.bukkit.enchantments.EnchantmentOffer;
-import org.bukkit.entity.*;
+import org.bukkit.entity.Entity;
+import org.bukkit.entity.EntitySnapshot;
+import org.bukkit.entity.FallingBlock;
+import org.bukkit.entity.Item;
+import org.bukkit.entity.Projectile;
+import org.bukkit.entity.Wither;
 import org.bukkit.event.entity.EntityDamageEvent.DamageCause;
 import org.bukkit.event.inventory.InventoryType;
 import org.bukkit.inventory.Inventory;

src/main/java/ch/njol/skript/registrations/Feature.java

@@ -15,7 +15,9 @@ public enum Feature implements Experiment {
 	QUEUES("queues", LifeCycle.EXPERIMENTAL),
 	FOR_EACH_LOOPS("for loop", LifeCycle.EXPERIMENTAL, "for [each] loop[s]"),
 	SCRIPT_REFLECTION("reflection", LifeCycle.EXPERIMENTAL, "[script] reflection"),
-	CATCH_ERRORS("catch runtime errors", LifeCycle.EXPERIMENTAL, "error catching [section]")
+	CATCH_ERRORS("catch runtime errors", LifeCycle.EXPERIMENTAL, "error catching [section]"),
+	EQUIPPABLE_COMPONENTS("equippable components", LifeCycle.EXPERIMENTAL, "equippable components"),
+	TOOL_COMPONENTS("tool components", LifeCycle.EXPERIMENTAL, "tool components")
 	;
 
 	private final String codeName;

src/main/java/ch/njol/skript/util/ItemSource.java

@@ -0,0 +1,45 @@
+package ch.njol.skript.util;
+
+import ch.njol.skript.bukkitutil.ItemUtils;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.ItemMeta;
+import ch.njol.skript.util.slot.Slot;
+import ch.njol.skript.aliases.ItemType;
+
+/**
+ * Container class for containing the origin of a {@link Slot}, {@link ItemStack}, and {@link ItemType}.
+ */
+public class ItemSource<T> {
+
+	private final T source;
+
+	public ItemSource(T source) {
+		ItemStack itemStack = ItemUtils.asItemStack(source);
+		if (itemStack == null)
+			throw new IllegalArgumentException("Object was not a Slot, ItemType or ItemStack");
+		this.source = source;
+	}
+
+	/**
+	 * Get the source object, can be a {@link Slot}, {@link ItemStack}, or {@link ItemType}.
+	 */
+	public T getSource() {
+		return source;
+	}
+
+	/**
+	 * Get the {@link ItemStack} retrieved from {@link #source}.
+	 */
+	public ItemStack getItemStack() {
+		return ItemUtils.asItemStack(source);
+	}
+
+	/**
+	 * Appropriately update the {@link ItemMeta} of {@link #source}.
+	 * @param itemMeta The {@link ItemMeta} to update {@link #source}
+	 */
+	public void setItemMeta(ItemMeta itemMeta) {
+		ItemUtils.setItemMeta(source, itemMeta);
+	}
+
+}

src/main/java/ch/njol/skript/util/ValidationResult.java

@@ -0,0 +1,58 @@
+package ch.njol.skript.util;
+
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Represents the result of a validation check.
+ * <p>
+ * 		This record stores whether a check was valid,
+ * 		an optional message explaining the result (i.e., an error or warning message),
+ * 		and optional data returned from the check if it successfully passed.
+ * </p>
+ *
+ * @param valid Whether the validation was successful.
+ * @param message An optional message describing the result.
+ * @param data Optional data returned from the validation.
+ * @param <T> The type of data returned from a successful validation.
+ */
+public record ValidationResult<T>(
+	boolean valid,
+	@Nullable String message,
+	@Nullable T data
+) {
+
+	/**
+	 * Constructs a {@link ValidationResult} with only a validity flag.
+	 * @param valid Whether the validation was successful.
+	 */
+	public ValidationResult(boolean valid) {
+		this(valid, null, null);
+	}
+
+	/**
+	 * Constructs a {@link ValidationResult} with a validity flag and message.
+	 * @param valid Whether the validation was successful.
+	 * @param message An optional message describing the result.
+	 */
+	public ValidationResult(boolean valid, @Nullable String message) {
+		this(valid, message, null);
+	}
+
+	/**
+	 * Constructs a {@link ValidationResult} with a validity flag and result data.
+	 * @param valid Whether the validation was successful.
+	 * @param data Optional data returned from the validation.
+	 */
+	public ValidationResult(boolean valid, @Nullable T data) {
+		this(valid, null, data);
+	}
+
+	/**
+	 * Constructs a {@link ValidationResult} with a validity flag, message and result data.
+	 * @param valid Whether the validation was successful.
+	 * @param message An optional message describing the result.
+	 * @param data Optional data returned from the validation.
+	 */
+	public ValidationResult {}
+
+}