Wolf Variants (#7041)

* Starter Files

* Notes

* Typo :)

* Fixxy Fix

Fixed, inability to operate on MC versions not containing 'Wolf.Variant'
Added, required data/types into lang
Added, test to spawn variant wolves
Added, spawning a wolf without a provided variant, will  choose a random one (Like Cats)

* Requested Changes

* Requested Changes - 2

* New Line + No Spacing

* Requested Change

* Conflict

---------

Co-authored-by: sovdee <10354869+sovdeeth@users.noreply.github.com>

Author: Absolutionism

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

@@ -32,6 +32,7 @@
 import ch.njol.skript.classes.Serializer;
 import ch.njol.skript.classes.registry.RegistryClassInfo;
 import ch.njol.skript.entity.EntityData;
+import ch.njol.skript.entity.WolfData;
 import ch.njol.skript.expressions.ExprDamageCause;
 import ch.njol.skript.expressions.base.EventValueExpression;
 import ch.njol.skript.lang.ParseContext;
@@ -67,6 +68,7 @@
 import org.bukkit.enchantments.Enchantment;
 import org.bukkit.enchantments.EnchantmentOffer;
 import org.bukkit.entity.Cat;
+import org.bukkit.entity.Wolf;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.Item;
 import org.bukkit.entity.LivingEntity;
@@ -1523,12 +1525,30 @@ 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")
 				.description("Represents the cause of the action of a potion effect on an entity, e.g. arrow, command")
 				.since("INSERT VERSION"));
+
+		ClassInfo<?> wolfVariantClassInfo;
+		if (Skript.classExists("org.bukkit.entity.Wolf$Variant") && BukkitUtils.registryExists("WOLF_VARIANT")) {
+			wolfVariantClassInfo = new RegistryClassInfo<>(Wolf.Variant.class, Registry.WOLF_VARIANT, "wolfvariant", "wolf variants");
+		} else {
+			/*
+			 * Registers a dummy/placeholder class to ensure working operation on MC versions that do not have `Wolf.Variant`
+			 */
+			wolfVariantClassInfo = new ClassInfo<>(WolfData.VariantDummy.class, "wolfvariant");
+		}
+		Classes.registerClass(wolfVariantClassInfo
+			.user("wolf ?variants?")
+			.name("Wolf Variant")
+			.description("Represents the variant of a wolf entity.",
+				"NOTE: Minecraft namespaces are supported, ex: 'minecraft:ashen'.")
+			.since("@VERSION")
+			.requiredPlugins("Minecraft 1.21+")
+			.documentationId("WolfVariant"));
 	}
 
 }

src/main/java/ch/njol/skript/entity/WolfData.java

@@ -18,24 +18,40 @@
  */
 package ch.njol.skript.entity;
 
+import ch.njol.skript.bukkitutil.BukkitUtils;
+import ch.njol.skript.registrations.Classes;
+import ch.njol.util.coll.CollectionUtils;
+import com.google.common.collect.Iterators;
 import org.bukkit.DyeColor;
 import org.bukkit.entity.Wolf;
 import org.jetbrains.annotations.Nullable;
 
+import ch.njol.skript.Skript;
 import ch.njol.skript.lang.Literal;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.util.Color;
 
+import java.util.Objects;
+
 public class WolfData extends EntityData<Wolf> {
 
+	private static boolean variantsEnabled = false;
+
 	static {
 		EntityData.register(WolfData.class, "wolf", Wolf.class, 1,
 				"peaceful wolf", "wolf", "angry wolf",
 				"wild wolf", "tamed wolf");
+		if (Skript.classExists("org.bukkit.entity.Wolf$Variant") && BukkitUtils.registryExists("WOLF_VARIANT")) {
+			variantsEnabled = true;
+			variants = Iterators.toArray(Classes.getExactClassInfo(Wolf.Variant.class).getSupplier().get(), Wolf.Variant.class);
+		}
 	}
 
-	@Nullable
-	private DyeColor collarColor;
+
+	private static Object[] variants;
+
+	private @Nullable Object variant;
+	private @Nullable DyeColor collarColor;
 
 	private int angry = 0;
 	private int tamed = 0;
@@ -47,8 +63,10 @@ protected boolean init(Literal<?>[] exprs, int matchedPattern, ParseResult parse
 			angry = matchedPattern - 1;
 		else
 			tamed = matchedPattern == 3 ? -1 : 1;
-		if (exprs[0] != null)
-			collarColor = ((Literal<Color>) exprs[0]).getSingle().asDyeColor();
+		if (exprs[0] != null && variantsEnabled)
+			variant = ((Literal<Wolf.Variant>) exprs[0]).getSingle();
+		if (exprs[1] != null)
+			collarColor = ((Literal<Color>) exprs[1]).getSingle().asDyeColor();
 		return true;
 	}
 
@@ -58,6 +76,8 @@ protected boolean init(@Nullable Class<? extends Wolf> c, @Nullable Wolf wolf) {
 			angry = wolf.isAngry() ? 1 : -1;
 			tamed = wolf.isTamed() ? 1 : -1;
 			collarColor = wolf.getCollarColor();
+			if (variantsEnabled)
+				variant = wolf.getVariant();
 		}
 		return true;
 	}
@@ -70,11 +90,17 @@ public void set(Wolf entity) {
 			entity.setTamed(tamed == 1);
 		if (collarColor != null)
 			entity.setCollarColor(collarColor);
+		Object variantSet = null;
+		if (variantsEnabled) {
+			variantSet = variant != null ? variant : CollectionUtils.getRandom(variants);
+			entity.setVariant((Wolf.Variant) variantSet);
+		}
 	}
 
 	@Override
 	public boolean match(Wolf entity) {
-		return (angry == 0 || entity.isAngry() == (angry == 1)) && (tamed == 0 || entity.isTamed() == (tamed == 1)) && (collarColor == null ? true : entity.getCollarColor() == collarColor);
+		return (angry == 0 || entity.isAngry() == (angry == 1)) && (tamed == 0 || entity.isTamed() == (tamed == 1)) &&
+			(collarColor == null || entity.getCollarColor() == collarColor) && (variant == null || entity.getVariant() == variant);
 	}
 
 	@Override
@@ -88,6 +114,8 @@ protected int hashCode_i() {
 		result = prime * result + angry;
 		result = prime * result + tamed;
 		result = prime * result + (collarColor == null ? 0 : collarColor.hashCode());
+		if (variantsEnabled)
+			result = prime * result + (variant == null ? 0 : Objects.hashCode(variant));
 		return result;
 	}
 
@@ -102,6 +130,8 @@ protected boolean equals_i(EntityData<?> obj) {
 			return false;
 		if (collarColor != other.collarColor)
 			return false;
+		if (variantsEnabled && variant != other.variant)
+			return false;
 		return true;
 	}
 
@@ -127,7 +157,7 @@ protected boolean deserialize(String s) {
 	public boolean isSupertypeOf(EntityData<?> entityData) {
 		if (entityData instanceof WolfData) {
 			WolfData wolfData = (WolfData) entityData;
-			return (angry == 0 || wolfData.angry == angry) && (tamed == 0 || wolfData.tamed == tamed) && (wolfData.collarColor == collarColor);
+			return (angry == 0 || wolfData.angry == angry) && (tamed == 0 || wolfData.tamed == tamed) && (wolfData.collarColor == collarColor) && (!variantsEnabled || wolfData.variant == variant);
 		}
 		return false;
 	}
@@ -137,4 +167,9 @@ public EntityData<Wolf> getSuperType() {
 		return new WolfData();
 	}
 
+	/**
+	 * A dummy/placeholder class to ensure working operation on MC versions that do not have `Wolf.Variant`
+	 */
+	public static class VariantDummy {};
+
 }

src/main/resources/lang/default.lang

@@ -813,19 +813,19 @@ entities:
 		pattern: wither skull((|1¦s)| projectile(|1¦s))
 	wolf:
 		name: wol¦f¦ves
-		pattern: <age> wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
+		pattern: <age> [%-wolfvariant%] wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
 	tamed wolf:
 		name: tamed wol¦f¦ves
-		pattern: (<age> dog(|1¦s)|tamed <age> wol(f|1¦ves)|(4¦)pupp(y|1¦ies)) [[with collar] colo[u]r[ed] %-color%]
+		pattern: (<age> [%-wolfvariant%] dog(|1¦s)|tamed <age> [%-wolfvariant%] wol(f|1¦ves)| [%-wolfvariant%] (4¦)pupp(y|1¦ies)) [[with collar] colo[u]r[ed] %-color%]
 	wild wolf:
 		name: wild wol¦f¦ves
-		pattern: (wild|untamed) <age> wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
+		pattern: (wild|untamed) <age> [%-wolfvariant%] wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
 	angry wolf:
 		name: angry wol¦f¦ves @an
-		pattern: (angry|aggressive) <age> wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
+		pattern: (angry|aggressive) <age> [%-wolfvariant%] wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
 	peaceful wolf:
 		name: peaceful wol¦f¦ves
-		pattern: (peaceful|neutral|unaggressive) <age> wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
+		pattern: (peaceful|neutral|unaggressive) <age> [%-wolfvariant%] wol(f|1¦ves) [[with collar] colo[u]r[ed] %-color%]
 	zombie:
 		name: zombie¦s
 		pattern: <age> zombie(|1¦s)|(4¦)zombie (kid(|1¦s)|child(|1¦ren))
@@ -1312,6 +1312,18 @@ cat types:
 	jellie: jellie
 	all_black: all black
 
+# -- Wolf Variants --
+wolf variants:
+	ashen: ashen
+	black: black
+	chestnut: chestnut
+	pale: pale
+	rusty: rusty
+	snowy: snowy
+	spotted: spotted
+	striped: striped
+	woods: woods
+
 # -- Damage Causes --
 damage causes:
 	contact: contact
@@ -2415,6 +2427,7 @@ types:
 	blockdata: block data¦s @a
 	healreason: heal reason¦s @a
 	cattype: cat type¦s @a
+	wolfvariant: wolf variant¦s @a
 	gamerule: gamerule¦s @a
 	attributetype: attribute type¦s @a
 	enchantmentoffer: enchantment offer¦s @an

src/test/skript/tests/syntaxes/effects/EffSpawn.sk

@@ -10,4 +10,18 @@ test "spawn cats by type" when running minecraft "1.15.2":
 	delete all siamese cats
 	assert size of all cats = 5 with "Size of all cats is not 5 after delete 2 siamese cats"
 	delete all cats
-	assert size of all cats = 0 with "Size of all cats is greater than 0 after all were deleted"
+	assert size of all cats = 0 with "Size of all cats is greater than 0 after all were deleted"
+
+test "spawn wolves by variant" when running minecraft "1.21.0":
+	delete all wolves
+	set {_l} to location of spawn of world "world"
+	spawn 5 ashen wolves at {_l}
+	assert size of all wolves = 5 with "Size of all wolves is not 5"
+	assert size of all ashen wolves = 5 with "Size of all ashen wolves is not 5"
+	spawn 2 rusty wolves at {_l}
+	assert size of all wolves = 7 with "Size of all wolves is not 7"
+	assert size of all rusty wolves = 2 with "Size of all rusty wolves is not 2"
+	delete all rusty wolves
+	assert size of all wolves = 5 with "Size of all wolves is not 5 after delete 2 rusty wolves"
+	delete all wolves
+	assert size of all wolves = 0 with "Size of all wolves is greater than 0 after all were deleted"