1.19.4 displays

build.gradle

@@ -31,7 +31,15 @@ dependencies {
 	shadow group: 'net.kyori', name: 'adventure-text-serializer-bungeecord', version: '4.3.2'
 
 	implementation group: 'io.papermc.paper', name: 'paper-api', version: '1.21-R0.1-SNAPSHOT'
+	implementation group: 'org.eclipse.jdt', name: 'org.eclipse.jdt.annotation', version: '2.2.700'
+
+	// Comes from Minecraft including Guava or Gson
 	implementation group: 'com.google.code.findbugs', name: 'findbugs', version: '3.0.1'
+
+	// bundled with Minecraft 1.19.4+ for display entity transforms
+	implementation group: 'org.joml', name: 'joml', version: '1.10.5'
+
+	// Plugin hook libraries
 	implementation group: 'com.sk89q.worldguard', name: 'worldguard-legacy', version: '7.0.0-SNAPSHOT'
 	implementation group: 'net.milkbowl.vault', name: 'Vault', version: '1.7.3', {
 		exclude group: 'org.bstats', module: 'bstats-bukkit'

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

@@ -97,6 +97,7 @@
 import org.junit.runner.JUnitCore;
 import org.junit.runner.Result;
 import org.skriptlang.skript.bukkit.SkriptMetrics;
+import org.skriptlang.skript.bukkit.displays.DisplayModule;
 import org.skriptlang.skript.lang.comparator.Comparator;
 import org.skriptlang.skript.lang.comparator.Comparators;
 import org.skriptlang.skript.lang.converter.Converter;
@@ -541,6 +542,9 @@ public void onEnable() {
 		try {
 			getAddonInstance().loadClasses("ch.njol.skript",
 				"conditions", "effects", "events", "expressions", "entity", "sections", "structures");
+			getAddonInstance().loadClasses("org.skriptlang.skript.bukkit", "misc");
+			// todo: become proper module once registry api is merged
+			DisplayModule.load();
 		} catch (final Exception e) {
 			exception(e, "Could not load required .class files: " + e.getLocalizedMessage());
 			setEnabled(false);

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

@@ -1414,6 +1414,22 @@ public Material getMaterial() {
 		return data.getType();
 	}
 
+	/**
+	 * @return A random block material this ItemType represents.
+	 * @throws IllegalStateException If {@link #hasBlock()} is false.
+	 */
+	public Material getBlockMaterial() {
+		List<ItemData> blockItemDatas = new ArrayList<>();
+		for (ItemData d : types) {
+			if (d.type.isBlock())
+				blockItemDatas.add(d);
+		}
+		if (blockItemDatas.isEmpty())
+			throw new IllegalStateException("This ItemType does not represent a material. " +
+					"ItemType#hasBlock() should return true before invoking this method.");
+		return blockItemDatas.get(random.nextInt(blockItemDatas.size())).getType();
+	}
+
 	/**
 	 * Returns a base item type of this. Essentially, this calls
 	 * {@link ItemData#aliasCopy()} on all datas and creates a new type
@@ -1427,4 +1443,5 @@ public ItemType getBaseType() {
 		}
 		return copy;
 	}
+
 }

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

@@ -18,18 +18,32 @@
  */
 package ch.njol.skript.classes.data;
 
-import java.io.StreamCorruptedException;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map.Entry;
-import java.util.UUID;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import java.util.stream.Collectors;
-
+import ch.njol.skript.Skript;
+import ch.njol.skript.SkriptConfig;
+import ch.njol.skript.aliases.Aliases;
+import ch.njol.skript.aliases.ItemType;
 import ch.njol.skript.bukkitutil.BukkitUtils;
+import ch.njol.skript.bukkitutil.EnchantmentUtils;
+import ch.njol.skript.bukkitutil.ItemUtils;
+import ch.njol.skript.classes.ClassInfo;
+import ch.njol.skript.classes.ConfigurationSerializer;
+import ch.njol.skript.classes.EnumClassInfo;
+import ch.njol.skript.classes.Parser;
+import ch.njol.skript.classes.Serializer;
+import ch.njol.skript.classes.registry.RegistryClassInfo;
+import ch.njol.skript.entity.EntityData;
+import ch.njol.skript.expressions.ExprDamageCause;
+import ch.njol.skript.expressions.base.EventValueExpression;
+import ch.njol.skript.lang.ParseContext;
+import ch.njol.skript.lang.util.SimpleLiteral;
+import ch.njol.skript.localization.Language;
+import ch.njol.skript.registrations.Classes;
+import ch.njol.skript.util.BlockUtils;
+import ch.njol.skript.util.PotionEffectUtils;
+import ch.njol.skript.util.StringMode;
+import ch.njol.util.StringUtils;
+import ch.njol.yggdrasil.Fields;
+import io.papermc.paper.world.MoonPhase;
 import org.bukkit.Bukkit;
 import org.bukkit.Chunk;
 import org.bukkit.Difficulty;
@@ -80,37 +94,19 @@
 import org.bukkit.potion.PotionEffectType;
 import org.bukkit.util.CachedServerIcon;
 import org.bukkit.util.Vector;
-
-import ch.njol.skript.Skript;
-import ch.njol.skript.SkriptConfig;
-import ch.njol.skript.aliases.Aliases;
-import ch.njol.skript.aliases.ItemType;
-import ch.njol.skript.bukkitutil.EnchantmentUtils;
-import ch.njol.skript.bukkitutil.ItemUtils;
-import ch.njol.skript.classes.ClassInfo;
-import ch.njol.skript.classes.ConfigurationSerializer;
-import ch.njol.skript.classes.EnumClassInfo;
-import ch.njol.skript.classes.Parser;
-import ch.njol.skript.classes.Serializer;
-import ch.njol.skript.classes.registry.RegistryClassInfo;
-import ch.njol.skript.entity.EntityData;
-import ch.njol.skript.expressions.ExprDamageCause;
-import ch.njol.skript.expressions.base.EventValueExpression;
-import ch.njol.skript.lang.ParseContext;
-import ch.njol.skript.lang.util.SimpleLiteral;
-import ch.njol.skript.localization.Language;
-import ch.njol.skript.registrations.Classes;
-import ch.njol.skript.util.BlockUtils;
-import ch.njol.skript.util.PotionEffectUtils;
-import ch.njol.skript.util.StringMode;
-import ch.njol.util.StringUtils;
-import ch.njol.yggdrasil.Fields;
-import io.papermc.paper.world.MoonPhase;
 import org.jetbrains.annotations.Nullable;
 
-/**
- * @author Peter Güttinger
- */
+import java.io.StreamCorruptedException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map.Entry;
+import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
 public class BukkitClasses {
 
 	public BukkitClasses() {}
@@ -1527,6 +1523,7 @@ public String toVariableNameString(EnchantmentOffer eo) {
 				.name("Transform Reason")
 				.description("Represents a transform reason of an <a href='events.html#entity transform'>entity transform event</a>.")
 				.since("2.8.0"));
+
 		Classes.registerClass(new EnumClassInfo<>(EntityPotionEffectEvent.Cause.class, "entitypotioncause", "entity potion causes")
 				.user("(entity )?potion ?effect ?cause")
 				.name("Entity Potion Cause")

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

@@ -29,6 +29,7 @@
 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;
@@ -75,20 +76,28 @@ public DefaultComparators() {}
 	static {
 
 		// Number - Number
-		Comparators.registerComparator(Number.class, Number.class, new Comparator<Number, Number>() {
+		Comparators.registerComparator(Number.class, Number.class, new Comparator<>() {
 			@Override
 			public Relation compare(Number n1, Number n2) {
 				if (n1 instanceof Long && n2 instanceof Long)
 					return Relation.get(n1.longValue() - n2.longValue());
-				Double d1 = n1.doubleValue(),
-					   d2 = n2.doubleValue();
+				double epsilon = Skript.EPSILON;
+				@SuppressWarnings("WrapperTypeMayBePrimitive") Double d1, d2;
+				if (n1 instanceof Float || n2 instanceof Float) {
+					d1 = (double) n1.floatValue();
+					d2 = (double) n2.floatValue();
+					epsilon = Math.min(d1, d2) * 1e-6; // dynamic epsilon
+				} else {
+					d1 = n1.doubleValue();
+					d2 = n2.doubleValue();
+				}
 				if (d1.isNaN() || d2.isNaN()) {
 					return Relation.SMALLER;
 				} else if (d1.isInfinite() || d2.isInfinite()) {
 					return d1 > d2 ? Relation.GREATER : d1 < d2 ? Relation.SMALLER : Relation.EQUAL;
 				} else {
 					double diff = d1 - d2;
-					if (Math.abs(diff) < Skript.EPSILON)
+					if (Math.abs(diff) < epsilon)
 						return Relation.EQUAL;
 					return Relation.get(diff);
 				}
@@ -656,6 +665,11 @@ public boolean supportsOrdering() {
 
 		// Potion Effect Type
 		Comparators.registerComparator(PotionEffectType.class, PotionEffectType.class, (one, two) -> Relation.get(one.equals(two)));
+
+		// Color - Color
+		Comparators.registerComparator(Color.class, Color.class, (one, two) -> Relation.get(one.asBukkitColor().equals(two.asBukkitColor())));
+		Comparators.registerComparator(Color.class, org.bukkit.Color.class, (one, two) -> Relation.get(one.asBukkitColor().equals(two)));
+		Comparators.registerComparator(org.bukkit.Color.class, org.bukkit.Color.class, (one, two) -> Relation.get(one.equals(two)));
 	}
 
 }

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

@@ -31,6 +31,7 @@
 import ch.njol.skript.registrations.DefaultClasses;
 import ch.njol.skript.util.Color;
 import ch.njol.skript.util.ColorRGB;
+import ch.njol.skript.util.Contract;
 import ch.njol.skript.util.Date;
 import ch.njol.util.Math2;
 import ch.njol.util.StringUtils;
@@ -42,7 +43,9 @@
 import org.bukkit.entity.Player;
 import org.bukkit.util.Vector;
 import org.jetbrains.annotations.Nullable;
-import ch.njol.skript.util.Contract;
+import org.joml.AxisAngle4f;
+import org.joml.Quaternionf;
+import org.joml.Vector3f;
 
 import java.math.BigDecimal;
 import java.math.RoundingMode;
@@ -525,19 +528,25 @@ public Long[] executeSimple(Object[][] params) {
 		Functions.registerFunction(new SimpleJavaFunction<Color>("rgb", new Parameter[] {
 			new Parameter<>("red", DefaultClasses.LONG, true, null),
 			new Parameter<>("green", DefaultClasses.LONG, true, null),
-			new Parameter<>("blue", DefaultClasses.LONG, true, null)
+			new Parameter<>("blue", DefaultClasses.LONG, true, null),
+			new Parameter<>("alpha", DefaultClasses.LONG, true, new SimpleLiteral<>(255L,true))
 		}, DefaultClasses.COLOR, true) {
 			@Override
 			public ColorRGB[] executeSimple(Object[][] params) {
 				Long red = (Long) params[0][0];
 				Long green = (Long) params[1][0];
 				Long blue = (Long) params[2][0];
+				Long alpha = (Long) params[3][0];
 
-				return CollectionUtils.array(new ColorRGB(red.intValue(), green.intValue(), blue.intValue()));
+				return CollectionUtils.array(ColorRGB.fromRGBA(red.intValue(), green.intValue(), blue.intValue(), alpha.intValue()));
 			}
-		}).description("Returns a RGB color from the given red, green and blue parameters.")
-			.examples("dye player's leggings rgb(120, 30, 45)")
-			.since("2.5");
+		}).description("Returns a RGB color from the given red, green and blue parameters. Alpha values can be added optionally, " +
+						"but these only take affect in certain situations, like text display backgrounds.")
+			.examples(
+				"dye player's leggings rgb(120, 30, 45)",
+				"set the colour of a text display to rgb(10, 50, 100, 50)"
+			)
+			.since("2.5, INSERT VERSION (alpha)");
 
 		Functions.registerFunction(new SimpleJavaFunction<Player>("player", new Parameter[] {
 			new Parameter<>("nameOrUUID", DefaultClasses.STRING, true, null),
@@ -634,6 +643,50 @@ public String[] executeSimple(Object[][] params) {
 				"concat(\"foo \", 100, \" bar\") # foo 100 bar"
 			).since("2.9.0");
 
+		// joml functions - for display entities
+		{
+			if (Skript.classExists("org.joml.Quaternionf")) {
+				Functions.registerFunction(new SimpleJavaFunction<>("quaternion", new Parameter[]{
+						new Parameter<>("w", DefaultClasses.NUMBER, true, null),
+						new Parameter<>("x", DefaultClasses.NUMBER, true, null),
+						new Parameter<>("y", DefaultClasses.NUMBER, true, null),
+						new Parameter<>("z", DefaultClasses.NUMBER, true, null)
+					}, Classes.getExactClassInfo(Quaternionf.class), true) {
+						@Override
+						public Quaternionf[] executeSimple(Object[][] params) {
+							double w = ((Number) params[0][0]).doubleValue();
+							double x = ((Number) params[1][0]).doubleValue();
+							double y = ((Number) params[2][0]).doubleValue();
+							double z = ((Number) params[3][0]).doubleValue();
+							return CollectionUtils.array(new Quaternionf(x, y, z, w));
+						}
+					})
+					.description("Returns a quaternion from the given W, X, Y and Z parameters. ")
+					.examples("quaternion(1, 5.6, 45.21, 10)")
+					.since("INSERT VERSION");
+			}
+
+			if (Skript.classExists("org.joml.AxisAngle4f")) {
+				Functions.registerFunction(new SimpleJavaFunction<>("axisAngle", new Parameter[]{
+						new Parameter<>("angle", DefaultClasses.NUMBER, true, null),
+						new Parameter<>("axis", DefaultClasses.VECTOR, true, null)
+					}, Classes.getExactClassInfo(Quaternionf.class), true) {
+						@Override
+						public Quaternionf[] executeSimple(Object[][] params) {
+							float angle = (float) (((Number) params[0][0]).floatValue() / 180 * Math.PI);
+							Vector v = ((Vector) params[1][0]);
+							if (v.isZero() || !Double.isFinite(v.getX()) || !Double.isFinite(v.getY()) || !Double.isFinite(v.getZ()))
+								return new Quaternionf[0];
+							Vector3f axis = ((Vector) params[1][0]).toVector3f();
+							return CollectionUtils.array(new Quaternionf(new AxisAngle4f(angle, axis)));
+						}
+					})
+					.description("Returns a quaternion from the given angle (in degrees) and axis (as a vector). This represents a rotation around the given axis by the given angle.")
+					.examples("axisangle(90, (vector from player's facing))")
+					.since("INSERT VERSION");
+			}
+		} // end joml functions
+
 	}
-	
+
 }

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

@@ -18,10 +18,12 @@
  */
 package ch.njol.skript.classes.data;
 
+import ch.njol.skript.Skript;
 import ch.njol.skript.SkriptConfig;
 import ch.njol.skript.classes.ClassInfo;
 import ch.njol.skript.classes.Parser;
 import ch.njol.skript.classes.Serializer;
+import ch.njol.skript.expressions.base.EventValueExpression;
 import ch.njol.skript.lang.ParseContext;
 import ch.njol.skript.lang.VariableString;
 import ch.njol.skript.lang.util.SimpleLiteral;
@@ -32,6 +34,7 @@
 import ch.njol.util.StringUtils;
 import ch.njol.yggdrasil.Fields;
 import org.jetbrains.annotations.Nullable;
+import org.joml.Quaternionf;
 
 import java.util.regex.Pattern;
 
@@ -627,5 +630,40 @@ public boolean mustSyncDeserialization() {
 						return false;
 					}
 				}));
+
+		// joml type - for display entities
+		if (Skript.classExists("org.joml.Quaternionf"))
+			Classes.registerClass(new ClassInfo<>(Quaternionf.class, "quaternion")
+					.user("quaternionf?s?")
+					.name("Quaternion")
+					.description("Quaternions are four dimensional vectors, often used for representing rotations.")
+					.since("INSERT VERSION")
+					.parser(new Parser<>() {
+						public boolean canParse(ParseContext context) {
+							return false;
+						}
+
+						@Override
+						public String toString(Quaternionf quaternion, int flags) {
+							return "w:" + Skript.toString(quaternion.w()) + ", x:" + Skript.toString(quaternion.x()) + ", y:" + Skript.toString(quaternion.y()) + ", z:" + Skript.toString(quaternion.z());
+						}
+
+						@Override
+						public String toVariableNameString(Quaternionf quaternion) {
+							return quaternion.w() + "," + quaternion.x() + "," + quaternion.y() + "," + quaternion.z();
+						}
+					})
+					.defaultExpression(new EventValueExpression<>(Quaternionf.class))
+					.cloner(quaternion -> {
+						try {
+							// Implements cloneable, but doesn't return a Quaternionf.
+							// org.joml improper override. Returns Object.
+							return (Quaternionf) quaternion.clone();
+						} catch (CloneNotSupportedException e) {
+							return null;
+						}
+					}));
+
 	}
+
 }