EnchantmentType - prepare for MC 1.21 custom enchantments

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

@@ -267,7 +267,7 @@ public static ItemType parseItemType(String s) {
 		}
 
 		String lc = s.toLowerCase(Locale.ENGLISH);
-		String of = Language.getSpaced("enchantments.of").toLowerCase();
+		String of = Language.getSpaced("of").toLowerCase();
 		int c = -1;
 		outer: while ((c = lc.indexOf(of, c + 1)) != -1) {
 			ItemType t2 = t.clone();

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

@@ -18,26 +18,106 @@
  */
 package ch.njol.skript.bukkitutil;
 
+import ch.njol.skript.localization.Language;
 import org.bukkit.NamespacedKey;
+import org.bukkit.Registry;
 import org.bukkit.enchantments.Enchantment;
 import org.eclipse.jdt.annotation.Nullable;
 
-import com.google.common.collect.BiMap;
-import com.google.common.collect.HashBiMap;
 import ch.njol.skript.Skript;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+
 /**
  * Maps enchantments to their keys.
  */
 public class EnchantmentUtils {
 
+	private static final Map<Enchantment, String> NAMES = new HashMap<>();
+	private static final Map<String, Enchantment> PATTERNS = new HashMap<>();
+	private static final boolean HAS_REGISTRY = Skript.classExists("org.bukkit.Registry") && Skript.fieldExists(Registry.class, "ENCHANTMENT");
+
+	static {
+		Language.addListener(() -> {
+			NAMES.clear();
+			PATTERNS.clear();
+			List<Enchantment> enchantments = new ArrayList<>();
+			if (HAS_REGISTRY) {
+				Registry.ENCHANTMENT.forEach(enchantments::add);
+			} else {
+				enchantments.addAll(Arrays.asList(Enchantment.values()));
+			}
+			for (Enchantment enchantment : enchantments) {
+				NamespacedKey key = enchantment.getKey();
+				final String[] names = Language.getList("enchantments." + key.getKey());
+
+				if (!names[0].startsWith("enchantments.")) {
+					NAMES.put(enchantment, names[0]);
+					// Add lang file names
+					for (String name : names)
+						PATTERNS.put(name.toLowerCase(Locale.ENGLISH), enchantment);
+				}
+				// If Minecraft provided, add key without namespace and underscores (ex: "fire aspect")
+				if (key.getNamespace().equalsIgnoreCase("minecraft"))
+					PATTERNS.put(key.getKey().replace("_", " "), enchantment);
+				// Add full namespaced key as pattern (ex: "minecraft:fire_aspect", "custom:floopy_floopy")
+				PATTERNS.put(key.toString(), enchantment);
+			}
+		});
+	}
+
 	public static String getKey(Enchantment enchantment) {
-		return enchantment.getKey().getKey();
+		return enchantment.getKey().toString();
 	}
 
 	@Nullable
 	public static Enchantment getByKey(String key) {
-		return Enchantment.getByKey(NamespacedKey.minecraft(key));
+		if (!key.contains(":")) {
+			// Old method for old variables
+			return Enchantment.getByKey(NamespacedKey.minecraft(key));
+		} else {
+			NamespacedKey namespacedKey = NamespacedKey.fromString(key);
+			if (namespacedKey == null)
+				return null;
+
+			if (HAS_REGISTRY) {
+				return Registry.ENCHANTMENT.get(namespacedKey);
+			} else {
+				return Enchantment.getByKey(namespacedKey);
+			}
+		}
+	}
+
+	@Nullable
+	public static Enchantment parseEnchantment(String s) {
+		return PATTERNS.get(s);
+	}
+
+	@SuppressWarnings("null")
+	public static Collection<String> getNames() {
+		return NAMES.values();
+	}
+
+	@SuppressWarnings("null")
+	public static String toString(final Enchantment enchantment) {
+		// If we have a name in the lang file, return that first
+		if (NAMES.containsKey(enchantment))
+			return NAMES.get(enchantment);
+
+		// If no name is available, return the namespaced key
+		return enchantment.getKey().toString();
+	}
+
+	// REMIND flags?
+	@SuppressWarnings("null")
+	public static String toString(final Enchantment enchantment, final int flags) {
+		return toString(enchantment);
 	}
 
 }

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

@@ -1226,7 +1226,7 @@ public boolean mustSyncDeserialization() {
 				.name("Enchantment")
 				.description("An enchantment, e.g. 'sharpness' or 'fortune'. Unlike <a href='#enchantmenttype'>enchantment type</a> " +
 						"this type has no level, but you usually don't need to use this type anyway.")
-				.usage(StringUtils.join(EnchantmentType.getNames(), ", "))
+				.usage(StringUtils.join(EnchantmentUtils.getNames(), ", "))
 				.examples("")
 				.since("1.4.6")
 				.before("enchantmenttype")
@@ -1235,12 +1235,12 @@ public boolean mustSyncDeserialization() {
 					@Override
 					@Nullable
 					public Enchantment parse(final String s, final ParseContext context) {
-						return EnchantmentType.parseEnchantment(s);
+						return EnchantmentUtils.parseEnchantment(s);
 					}
 
 					@Override
 					public String toString(final Enchantment e, final int flags) {
-						return EnchantmentType.toString(e, flags);
+						return EnchantmentUtils.toString(e, flags);
 					}
 
 					@Override
@@ -1505,12 +1505,12 @@ public boolean canParse(ParseContext context) {
 
 					@Override
 					public String toString(EnchantmentOffer eo, int flags) {
-						return EnchantmentType.toString(eo.getEnchantment(), flags) + " " + eo.getEnchantmentLevel();
+						return EnchantmentUtils.toString(eo.getEnchantment(), flags) + " " + eo.getEnchantmentLevel();
 					}
 
 					@Override
 					public String toVariableNameString(EnchantmentOffer eo) {
-						return "offer:" + EnchantmentType.toString(eo.getEnchantment()) + "=" + eo.getEnchantmentLevel();
+						return "offer:" + EnchantmentUtils.toString(eo.getEnchantment()) + "=" + eo.getEnchantmentLevel();
 					}
 				}));
 

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

@@ -18,30 +18,23 @@
  */
 package ch.njol.skript.util;
 
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.Locale;
-import java.util.Map;
 import java.util.regex.Pattern;
 
+import ch.njol.skript.bukkitutil.EnchantmentUtils;
 import org.bukkit.enchantments.Enchantment;
 import org.eclipse.jdt.annotation.Nullable;
 
 import ch.njol.skript.aliases.ItemType;
-import ch.njol.skript.bukkitutil.EnchantmentUtils;
-import ch.njol.skript.localization.Language;
 import ch.njol.yggdrasil.YggdrasilSerializable;
 
 /**
  * @author Peter Güttinger
  */
 public class EnchantmentType implements YggdrasilSerializable {
-
-	private final static String LANGUAGE_NODE = "enchantments";
-
+
 	private final Enchantment type;
 	private final int level;
-	
+
 	/**
 	 * Used for deserialisation only
 	 */
@@ -50,7 +43,7 @@ private EnchantmentType() {
 		type = null;
 		level = -1;
 	}
-	
+
 	public EnchantmentType(final Enchantment type) {
 		assert type != null;
 		this.type = type;
@@ -61,26 +54,26 @@ public EnchantmentType(final Enchantment type, final int level) {
 		this.type = type;
 		this.level = level;
 	}
-	
+
 	/**
 	 * @return level or 1 if level == -1
 	 */
 	public int getLevel() {
 		return level == -1 ? 1 : level;
 	}
-	
+
 	/**
 	 * @return the internal level, can be -1
 	 */
 	public int getInternalLevel() {
 		return level;
 	}
-	
+
 	@Nullable
 	public Enchantment getType() {
 		return type;
 	}
-	
+
 	/**
 	 * Checks whether the given item type has this enchantment.
 	 * @param item the item to be checked.
@@ -90,43 +83,15 @@ public Enchantment getType() {
 	public boolean has(final ItemType item) {
 		return item.hasEnchantments(type);
 	}
-	
+
 	@Override
 	public String toString() {
-		return toString(type) + (level == -1 ? "" : " " + level);
-	}
-
-	@SuppressWarnings("null")
-	public static String toString(final Enchantment e) {
-		return NAMES.get(e);
+		return EnchantmentUtils.toString(type) + (level == -1 ? "" : " " + level);
 	}
-
-	// REMIND flags?
-	@SuppressWarnings("null")
-	public static String toString(final Enchantment e, final int flags) {
-		return NAMES.get(e);
-	}
-
-	private final static Map<Enchantment, String> NAMES = new HashMap<>();
-	private final static Map<String, Enchantment> PATTERNS = new HashMap<>();
-
-	static {
-		Language.addListener(() -> {
-			NAMES.clear();
-			for (Enchantment e : Enchantment.values()) {
-				assert e != null;
-				final String[] names = Language.getList(LANGUAGE_NODE + ".names." + EnchantmentUtils.getKey(e));
-				NAMES.put(e, names[0]);
-
-				for (String name : names)
-					PATTERNS.put(name.toLowerCase(Locale.ENGLISH), e);
-			}
-		});
-	}
-
+
 	@SuppressWarnings("null")
 	private final static Pattern pattern = Pattern.compile(".+ \\d+");
-	
+
 	/**
 	 * Parses an enchantment type from string. This includes an {@link Enchantment}
 	 * and its level.
@@ -138,29 +103,19 @@ public static EnchantmentType parse(final String s) {
 		if (pattern.matcher(s).matches()) {
 			String name = s.substring(0, s.lastIndexOf(' '));
 			assert name != null;
-			final Enchantment ench = parseEnchantment(name);
+			final Enchantment ench = EnchantmentUtils.parseEnchantment(name);
 			if (ench == null)
 				return null;
 			String level = s.substring(s.lastIndexOf(' ') + 1);
 			assert level != null;
 			return new EnchantmentType(ench, Utils.parseInt(level));
 		}
-		final Enchantment ench = parseEnchantment(s);
+		final Enchantment ench = EnchantmentUtils.parseEnchantment(s);
 		if (ench == null)
 			return null;
 		return new EnchantmentType(ench, -1);
 	}
-
-	@Nullable
-	public static Enchantment parseEnchantment(final String s) {
-		return PATTERNS.get(s.toLowerCase(Locale.ENGLISH));
-	}
-
-	@SuppressWarnings("null")
-	public static Collection<String> getNames() {
-		return NAMES.values();
-	}
-
+
 	@Override
 	public int hashCode() {
 		final int prime = 31;
@@ -169,7 +124,7 @@ public int hashCode() {
 		result = prime * result + type.hashCode();
 		return result;
 	}
-	
+
 	@Override
 	public boolean equals(final @Nullable Object obj) {
 		if (this == obj)
@@ -183,5 +138,5 @@ public boolean equals(final @Nullable Object obj) {
 			return false;
 		return type.equals(other.type);
 	}
-	
+
 }