Merge branch 'dev/feature' into feature/better-enchanted-condition

Author: sovdeeth

.github/pull_request_template.md

@@ -1,7 +1,19 @@
-### Description
-<!--- Describe your changes here. --->
+### Problem
+<!--- Why is this PR necessary? What problems exist that needed solving?  --->
+
+
+### Solution
+<!--- Explain how your solution fixes the problem and summarize the major code changes.  --->
+
+
+### Testing Completed
+<!--- List test scripts/unit tests and any manual testing that was performed. If no test scripts or unit tests are present, explain why.  --->
+
+
+### Supporting Information
+<!--- Any related information, todos, breaking changes, or outstanding issues can be described here --->
+
 
 ---
-**Target Minecraft Versions:** any <!-- 'any' means all supported versions -->
-**Requirements:** none <!-- Required plugins, server software... -->
-**Related Issues:** none <!-- Links to related issues -->
+**Completes:** none <!-- Links to issues or discussions that should be completed when this PR is merged. -->
+**Related:** none <!-- Links to issues or discussions with related information -->

build.gradle

@@ -27,7 +27,7 @@ allprojects {
 dependencies {
 	shadow group: 'io.papermc', name: 'paperlib', version: '1.0.8'
 	shadow group: 'org.bstats', name: 'bstats-bukkit', version: '3.1.0'
-	shadow group: 'net.kyori', name: 'adventure-text-serializer-bungeecord', version: '4.3.4'
+	shadow group: 'net.kyori', name: 'adventure-text-serializer-bungeecord', version: '4.4.0'
 
 	implementation group: 'io.papermc.paper', name: 'paper-api', version: '1.21.5-R0.1-SNAPSHOT'
 	implementation group: 'com.google.code.findbugs', name: 'findbugs', version: '3.0.1'

gradle.properties

@@ -5,7 +5,7 @@ org.gradle.parallel=true
 
 groupid=ch.njol
 name=skript
-version=2.11.1
+version=2.11.2
 jarName=Skript.jar
 testEnv=java21/paper-1.21.5
 testEnvJavaVersion=21

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

@@ -11,17 +11,15 @@
 import ch.njol.skript.classes.*;
 import ch.njol.skript.classes.registry.RegistryClassInfo;
 import ch.njol.skript.entity.EntityData;
-import ch.njol.skript.entity.WolfData;
+import ch.njol.skript.entity.PigData.PigVariantDummy;
+import ch.njol.skript.entity.WolfData.WolfVariantDummy;
 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.skript.util.Utils;
+import ch.njol.skript.util.*;
 import ch.njol.yggdrasil.Fields;
 import io.papermc.paper.world.MoonPhase;
 import org.bukkit.*;
@@ -44,6 +42,7 @@
 import org.bukkit.event.entity.EntityRegainHealthEvent.RegainReason;
 import org.bukkit.event.entity.EntityTransformEvent.TransformReason;
 import org.bukkit.event.entity.EntityUnleashEvent;
+import org.bukkit.event.entity.VillagerCareerChangeEvent;
 import org.bukkit.event.inventory.ClickType;
 import org.bukkit.event.inventory.InventoryAction;
 import org.bukkit.event.inventory.InventoryCloseEvent;
@@ -52,6 +51,7 @@
 import org.bukkit.event.player.PlayerQuitEvent.QuitReason;
 import org.bukkit.event.player.PlayerResourcePackStatusEvent.Status;
 import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
+import org.bukkit.inventory.BlockInventoryHolder;
 import org.bukkit.inventory.*;
 import org.bukkit.metadata.Metadatable;
 import org.bukkit.potion.PotionEffect;
@@ -1410,14 +1410,15 @@ public String toVariableNameString(EnchantmentOffer eo) {
 				.description("Represents the cause of the action of a potion effect on an entity, e.g. arrow, command")
 				.since("2.10"));
 
-		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");
+		ClassInfo<?> wolfVariantClassInfo = getRegistryClassInfo(
+			"org.bukkit.entity.Wolf$Variant",
+			"WOLF_VARIANT",
+			"wolfvariant",
+			"wolf variants"
+		);
+		if (wolfVariantClassInfo == null) {
+			// Registers a dummy/placeholder class to ensure working operation on MC versions that do not have 'Wolf.Variant' (1.20.4-)
+			wolfVariantClassInfo = new ClassInfo<>(WolfVariantDummy.class, "wolfvariant");
 		}
 		Classes.registerClass(wolfVariantClassInfo
 			.user("wolf ?variants?")
@@ -1550,14 +1551,82 @@ public String toVariableNameString(WorldBorder border) {
 			.changer(DefaultChangers.entityChanger)
 		);
 
-
 		Classes.registerClass(new EnumClassInfo<>(EquipmentSlot.class, "equipmentslot", "equipment slots")
 			.user("equipment ?slots?")
 			.name("Equipment Slot")
 			.description("Represents an equipment slot of an entity.")
 			.since("2.11")
 		);
 
+		ClassInfo<?> pigVariantClassInfo = getRegistryClassInfo(
+			"org.bukkit.entity.Pig$Variant",
+			"PIG_VARIANT",
+			"pigvariant",
+			"pig variants"
+		);
+		if (pigVariantClassInfo == null) {
+			// Registers a dummy/placeholder class to ensure working operation on MC versions that do not have 'Pig.Variant' (1.21.4-)
+			pigVariantClassInfo = new ClassInfo<>(PigVariantDummy.class, "pigvariant");
+		}
+		Classes.registerClass(pigVariantClassInfo
+			.user("pig ?variants?")
+			.name("Pig Variant")
+			.description("Represents the variant of a pig entity.",
+				"NOTE: Minecraft namespaces are supported, ex: 'minecraft:warm'.")
+			.since("INSERT VERSION")
+			.requiredPlugins("Minecraft 1.21.5+")
+			.documentationId("PigVariant"));
+
+		Classes.registerClass(new EnumClassInfo<>(VillagerCareerChangeEvent.ChangeReason.class, "villagercareerchangereason", "villager career change reasons")
+			.user("(villager )?career ?change ?reasons?")
+			.name("Villager Career Change Reason")
+			.description("Represents a reason why a villager changed its career.")
+			.since("INSERT VERSION")
+		);
+
+	}
+
+	/**
+	 * Gets a {@link RegistryClassInfo} by checking if the {@link Class} from {@code classPath} exists
+	 * and {@link Registry} or {@link io.papermc.paper.registry.RegistryKey} contains {@code registryName}.
+	 * @param classPath The {@link String} representation of the desired {@link Class}.
+	 * @param registryName The {@link String} representation of the desired {@link Registry}.
+	 * @param codeName The name used in patterns.
+	 * @param languageNode The language node of the type.
+	 * @return {@link RegistryClassInfo} if the class and registry exists, otherwise {@code null}.
+	 */
+	private static <R extends Keyed> @Nullable RegistryClassInfo<?> getRegistryClassInfo(
+		String classPath,
+		String registryName,
+		String codeName,
+		String languageNode
+	) {
+		if (!Skript.classExists(classPath))
+			return null;
+		Registry<R> registry = null;
+		if (BukkitUtils.registryExists(registryName)) {
+			try {
+				//noinspection unchecked
+				registry = (Registry<R>) Registry.class.getField(registryName).get(null);
+			} catch (NoSuchFieldException | IllegalAccessException e) {
+				throw new RuntimeException(e);
+			}
+		} else if (PaperUtils.registryExists(registryName)) {
+			registry = PaperUtils.getBukkitRegistry(registryName);
+		}
+		if (registry != null) {
+			Class<R> registryClass;
+			try {
+				//noinspection unchecked
+				registryClass = (Class<R>) Class.forName(classPath);
+			} catch (ClassNotFoundException e) {
+				Skript.debug("Could not retrieve the class with the path: '" + classPath + "'.");
+				throw new RuntimeException(e);
+			}
+			return new RegistryClassInfo<>(registryClass, registry, codeName, languageNode);
+		}
+		Skript.debug("There were no registries found for '" + registryName + "'.");
+		return null;
 	}
 
 }

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

@@ -13,7 +13,6 @@
 import ch.njol.skript.util.*;
 import ch.njol.skript.util.slot.InventorySlot;
 import ch.njol.skript.util.slot.Slot;
-import com.destroystokyo.paper.event.block.AnvilDamagedEvent;
 import com.destroystokyo.paper.event.block.BeaconEffectEvent;
 import com.destroystokyo.paper.event.entity.EndermanAttackPlayerEvent;
 import com.destroystokyo.paper.event.entity.ProjectileCollideEvent;
@@ -33,6 +32,7 @@
 import org.bukkit.command.BlockCommandSender;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.*;
+import org.bukkit.entity.Villager.Profession;
 import org.bukkit.event.block.*;
 import org.bukkit.event.enchantment.EnchantItemEvent;
 import org.bukkit.event.enchantment.PrepareItemEnchantEvent;
@@ -547,8 +547,6 @@ else if (hand == EquipmentSlot.OFF_HAND)
 			EventValues.registerEventValue(EntityMoveEvent.class, Location.class, EntityMoveEvent::getFrom);
 			EventValues.registerEventValue(EntityMoveEvent.class, Location.class, EntityMoveEvent::getTo, TIME_FUTURE);
 		}
-		//PlayerToggleFlightEvent
-		EventValues.registerEventValue(PlayerToggleFlightEvent.class, Player.class, PlayerEvent::getPlayer);
 		//CreatureSpawnEvent
 		EventValues.registerEventValue(CreatureSpawnEvent.class, SpawnReason.class, CreatureSpawnEvent::getSpawnReason);
 		//FireworkExplodeEvent
@@ -773,6 +771,23 @@ public void set(VaultDisplayItemEvent event, @Nullable ItemStack itemStack) {
 			});
 		}
 
+		EventValues.registerEventValue(VillagerCareerChangeEvent.class, VillagerCareerChangeEvent.ChangeReason.class, VillagerCareerChangeEvent::getReason);
+		EventValues.registerEventValue(VillagerCareerChangeEvent.class, Villager.Profession.class, new EventConverter<>() {
+			@Override
+			public void set(VillagerCareerChangeEvent event, @Nullable Profession profession) {
+				if (profession == null)
+					return;
+				event.setProfession(profession);
+			}
+
+			@Override
+			public Profession convert(VillagerCareerChangeEvent event) {
+				return event.getProfession();
+			}
+		});
+		EventValues.registerEventValue(VillagerCareerChangeEvent.class, Villager.Profession.class,
+			event -> event.getEntity().getProfession(), TIME_PAST);
+
 	}
 
 }

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

@@ -4,7 +4,6 @@
 import ch.njol.skript.util.Timespan;
 import ch.njol.skript.util.Timespan.TimePeriod;
 import ch.njol.skript.util.Utils;
-import ch.njol.util.Math2;
 import org.bukkit.util.Vector;
 import org.skriptlang.skript.lang.arithmetic.Arithmetics;
 import org.skriptlang.skript.lang.arithmetic.Operator;
@@ -91,9 +90,9 @@ public class DefaultOperations {
 		});
 
 		// Timespan - Timespan
-		Arithmetics.registerOperation(Operator.ADDITION, Timespan.class, (left, right) -> new Timespan(Math2.addClamped(left.getAs(TimePeriod.MILLISECOND), right.getAs(TimePeriod.MILLISECOND))));
-		Arithmetics.registerOperation(Operator.SUBTRACTION, Timespan.class, (left, right) -> new Timespan(Math.max(0, left.getAs(TimePeriod.MILLISECOND) - right.getAs(TimePeriod.MILLISECOND))));
-		Arithmetics.registerDifference(Timespan.class, (left, right) -> new Timespan(Math.abs(left.getAs(TimePeriod.MILLISECOND) - right.getAs(TimePeriod.MILLISECOND))));
+		Arithmetics.registerOperation(Operator.ADDITION, Timespan.class, Timespan::add);
+		Arithmetics.registerOperation(Operator.SUBTRACTION, Timespan.class, Timespan::subtract);
+		Arithmetics.registerDifference(Timespan.class, Timespan::difference);
 		Arithmetics.registerDefaultValue(Timespan.class, Timespan::new);
 
 		// Timespan - Number

src/main/java/ch/njol/skript/conditions/CondStriderIsShivering.java

@@ -0,0 +1,34 @@
+package ch.njol.skript.conditions;
+
+import ch.njol.skript.conditions.base.PropertyCondition;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Example;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import org.bukkit.entity.LivingEntity;
+import org.bukkit.entity.Strider;
+
+@Name("Strider Is Shivering")
+@Description("Whether a strider is shivering.")
+@Example("""
+	if last spawned strider is shivering:
+		make last spawned strider stop shivering
+	""")
+@Since("INSERT VERSION")
+public class CondStriderIsShivering extends PropertyCondition<LivingEntity> {
+
+	static {
+		register(CondStriderIsShivering.class, "shivering", "livingentities");
+	}
+
+	@Override
+	public boolean check(LivingEntity entity) {
+		return entity instanceof Strider strider && strider.isShivering();
+	}
+
+	@Override
+	protected String getPropertyName() {
+		return "shivering";
+	}
+
+}

src/main/java/ch/njol/skript/effects/EffExit.java

@@ -101,7 +101,7 @@ public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelaye
 		debug(event, false);
 		for (SectionExitHandler section : sectionsToExit)
 			section.exit(event);
-		if (outerSection == null)
+		if (outerSection == null) // "stop trigger"
 			return null;
 		return outerSection instanceof LoopSection loopSection ? loopSection.getActualNext() : outerSection.getNext();
 	}
@@ -113,11 +113,15 @@ protected void execute(Event event) {
 
 	@Override
 	public @Nullable ExecutionIntent executionIntent() {
+		if (outerSection == null)
+			return ExecutionIntent.stopTrigger();
 		return ExecutionIntent.stopSections(breakLevels);
 	}
 
 	@Override
 	public String toString(@Nullable Event event, boolean debug) {
+		if (outerSection == null)
+			return "stop trigger";
 		return "stop " + breakLevels + " " + names[type];
 	}