🚀 Improve toString of ItemData

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

@@ -18,18 +18,22 @@
  */
 package ch.njol.skript.aliases;
 
-import java.io.IOException;
-import java.io.NotSerializableException;
-import java.io.StreamCorruptedException;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
-
+import ch.njol.skript.Skript;
+import ch.njol.skript.bukkitutil.BukkitUnsafe;
+import ch.njol.skript.bukkitutil.ItemUtils;
+import ch.njol.skript.bukkitutil.block.BlockCompat;
+import ch.njol.skript.bukkitutil.block.BlockValues;
+import ch.njol.skript.localization.GeneralWords;
+import ch.njol.skript.localization.Language;
+import ch.njol.skript.localization.Message;
+import ch.njol.skript.util.EnchantmentType;
+import ch.njol.skript.util.SkriptColor;
+import ch.njol.skript.variables.Variables;
+import ch.njol.util.EnumTypeAdapter;
+import ch.njol.yggdrasil.Fields;
+import ch.njol.yggdrasil.YggdrasilSerializable.YggdrasilExtendedSerializable;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
 import org.bukkit.Bukkit;
 import org.bukkit.Material;
 import org.bukkit.OfflinePlayer;
@@ -47,18 +51,18 @@
 import org.bukkit.potion.PotionData;
 import org.eclipse.jdt.annotation.Nullable;
 
-import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
-import ch.njol.util.EnumTypeAdapter;
-import ch.njol.skript.Skript;
-import ch.njol.skript.bukkitutil.BukkitUnsafe;
-import ch.njol.skript.bukkitutil.ItemUtils;
-import ch.njol.skript.bukkitutil.block.BlockCompat;
-import ch.njol.skript.bukkitutil.block.BlockValues;
-import ch.njol.skript.localization.Message;
-import ch.njol.skript.variables.Variables;
-import ch.njol.yggdrasil.Fields;
-import ch.njol.yggdrasil.YggdrasilSerializable.YggdrasilExtendedSerializable;
+import java.io.IOException;
+import java.io.NotSerializableException;
+import java.io.StreamCorruptedException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Objects;
+import java.util.Set;
 
 public class ItemData implements Cloneable, YggdrasilExtendedSerializable {
 
@@ -116,7 +120,8 @@ public static class OldItemData {
 	}
 
 	private final static Message m_named = new Message("aliases.named");
-
+	private final static Message m_with_lore = new Message("aliases.with lore");
+
 	/**
 	 * Before 1.13, data values ("block states") are applicable to items.
 	 */
@@ -271,13 +276,55 @@ public String toString() {
 	}
 
 	public String toString(final boolean debug, final boolean plural) {
-		StringBuilder builder = new StringBuilder(Aliases.getMaterialName(this, plural));
+		StringBuilder b = new StringBuilder(Aliases.getMaterialName(this, plural));
 		ItemMeta meta = stack.getItemMeta();
-		if (meta != null && meta.hasDisplayName()) {
-			builder.append(" ").append(m_named).append(" ");
-			builder.append(meta.getDisplayName());
+
+		Map<Enchantment, Integer> enchs = stack.getEnchantments();
+		if (!enchs.isEmpty()) {
+			b.append(Language.getSpaced("enchantments.of"));
+			int i = 0;
+			for (Entry<Enchantment, Integer> e : enchs.entrySet()) {
+				if (i != 0) {
+					if (i != enchs.size() - 1) {
+						b.append(", ");
+					} else  {
+						b.append(" " + GeneralWords.and + " ");
+					}
+				}
+				Enchantment ench = e.getKey();
+				if (ench == null)
+					continue;
+				b.append(EnchantmentType.toString(ench));
+				b.append(" ");
+				b.append(e.getValue());
+				i++;
+			}
 		}
-		return builder.toString();
+
+		if (meta != null) {
+			if (meta.hasDisplayName()) {
+				b.append(" ").append(m_named).append(" ");
+				b.append("\"").append(SkriptColor.replaceColorChar(meta.getDisplayName())).append("\"");
+			}
+			if (meta.hasLore()) {
+				b.append(" ").append(m_with_lore).append(" ");
+				List<String> lore = meta.getLore();
+				int i = 0;
+				for (String l : lore) {
+					if (i != 0) {
+						if (i != lore.size() - 1)  {
+							b.append(", ");
+						} else {
+							b.append(" " + GeneralWords.and + " ");
+						}
+					}
+					b.append("\"").append(SkriptColor.replaceColorChar(l)).append("\"");
+					i++;
+				}
+			}
+		}
+
+		return b.toString();
 	}
 
 	/**

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

@@ -34,7 +34,6 @@
 import java.util.RandomAccess;
 import java.util.Set;
 
-import ch.njol.skript.classes.Comparator.Relation;
 import org.bukkit.Location;
 import org.bukkit.Material;
 import org.bukkit.block.Block;
@@ -980,16 +979,6 @@ public String toString(final int flags, final @Nullable Adjective a) {
 
 	private String toString(final boolean debug, final int flags, final @Nullable Adjective a) {
 		final StringBuilder b = new StringBuilder();
-//		if (types.size() == 1 && !types.get(0).hasDataRange()) {
-//			if (getAmount() != 1)
-//				b.append(amount + " ");
-//			if (isAll())
-//				b.append(getAmount() == 1 ? "every " : "of every ");
-//		} else {
-//			if (getAmount() != 1)
-//				b.append(amount + " of ");
-//			b.append(isAll() ? "every " : "any ");
-//		}
 		final boolean plural = amount != 1 && amount != -1 || (flags & Language.F_PLURAL) != 0;
 		if (amount != -1 && amount != 1) {
 			b.append(amount + " ");
@@ -1007,36 +996,7 @@ private String toString(final boolean debug, final int flags, final @Nullable Ad
 			}
 			b.append(types.get(i).toString(debug, plural));
 		}
-//		final Map<Enchantment, Integer> enchs = enchantments;
-//		if (enchs == null)
-//			return "" + b.toString();
-//		b.append(Language.getSpaced("enchantments.of"));
-//		int i = 0;
-//		for (final Entry<Enchantment, Integer> e : enchs.entrySet()) {
-//			if (i != 0) {
-//				if (i != enchs.size() - 1)
-//					b.append(", ");
-//				else
-//					b.append(" " + GeneralWords.and + " ");
-//			}
-//			final Enchantment ench = e.getKey();
-//			if (ench == null)
-//				continue;
-//			b.append(EnchantmentType.toString(ench));
-//			b.append(" ");
-//			b.append(e.getValue());
-//			i++;
-//		}
-//		if (meta != null) {
-//			final ItemMeta m = (ItemMeta) meta;
-//			if (m.hasDisplayName()) {
-//				b.append(" " + m_named.toString() + " ");
-//				b.append("\"" + m.getDisplayName() + "\"");
-//			}
-//			if (debug)
-//				b.append(" meta=[").append(meta).append("]");
-//		}
-		return "" + b.toString();
+		return b.toString();
 	}
 
 	public static String toString(final ItemStack i) {

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

@@ -25,6 +25,7 @@
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
+import java.util.regex.Pattern;
 
 import org.bukkit.ChatColor;
 import org.bukkit.DyeColor;
@@ -62,7 +63,7 @@ public enum SkriptColor implements Color {
 
 	DARK_PURPLE(DyeColor.PURPLE, ChatColor.DARK_PURPLE),
 	LIGHT_PURPLE(DyeColor.MAGENTA, ChatColor.LIGHT_PURPLE);
-	
+
 	private final static Map<String, SkriptColor> names = new HashMap<>();
 	private final static Set<SkriptColor> colors = new HashSet<>();
 	private final static String LANGUAGE_NODE = "colors";
@@ -219,7 +220,18 @@ public static SkriptColor fromWoolData(short data) {
 		}
 		return null;
 	}
-
+
+	/**
+	 * Replace chat color character '§' with '&'
+	 * This is an alternative method to {@link ChatColor#stripColor(String)}
+	 * But does not strip the color code.
+	 * @param s string to replace chat color character of.
+	 * @return String with replaced chat color character
+	 */
+	public static String replaceColorChar(String s) {
+		return s.replace('\u00A7', '&');
+	}
+
 	@Override
 	public String toString() {
 		return adjective == null ? "" + name() : adjective.toString(-1, 0);

src/main/resources/lang/default.lang

@@ -44,6 +44,7 @@ aliases:
 	of: of(?: any)?
 
 	named: named
+	with lore: with lore
 
 # -- Enchantments --
 enchantments: