1.21.11 update (#2798)

Author: tal5

README.md

@@ -3,7 +3,7 @@ The Denizen Scripting Language - Spigot Impl
 
 An implementation of the Denizen Scripting Language for Spigot servers, with strong Citizens interlinks to emphasize the power of using Denizen with NPCs!
 
-**Version 1.3.1**: Compatible with Spigot 1.17.1, 1.18.2, 1.19.4, 1.20.6, and 1.21.10!
+**Version 1.3.1**: Compatible with Spigot 1.17.1, 1.18.2, 1.19.4, 1.20.6, and 1.21.11!
 
 **Learn about Denizen from the Beginner's guide:** https://guide.denizenscript.com/guides/background/index.html
 

paper/pom.xml

@@ -25,13 +25,13 @@
         <dependency>
             <groupId>io.papermc.paper</groupId>
             <artifactId>paper-api</artifactId>
-            <version>1.21.10-R0.1-SNAPSHOT</version>
+            <version>1.21.11-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>net.citizensnpcs</groupId>
             <artifactId>citizens-main</artifactId>
-            <version>2.0.38-SNAPSHOT</version>
+            <version>2.0.41-SNAPSHOT</version>
             <type>jar</type>
             <scope>provided</scope>
             <exclusions>

paper/src/main/java/com/denizenscript/denizen/paper/events/WorldGameRuleChangeScriptEvent.java

@@ -7,6 +7,7 @@
 import com.denizenscript.denizen.objects.PlayerTag;
 import com.denizenscript.denizen.objects.WorldTag;
 import com.denizenscript.denizen.utilities.implementation.BukkitScriptEntryData;
+import com.denizenscript.denizen.utilities.world.GameRuleReflect;
 import com.denizenscript.denizencore.objects.ObjectTag;
 import com.denizenscript.denizencore.objects.core.ElementTag;
 import com.denizenscript.denizencore.scripts.ScriptEntryData;
@@ -69,7 +70,7 @@ public boolean matches(ScriptPath path) {
         if (path.eventArgLowerAt(2).equals("in") && !path.tryArgObject(3, world)) {
             return false;
         }
-        if (!runGenericSwitchCheck(path, "gamerule", event.getGameRule().getName())) {
+        if (!runGenericSwitchCheck(path, "gamerule", GameRuleReflect.getName(event.getGameRule()))) {
             return false;
         }
         return super.matches(path);
@@ -78,7 +79,7 @@ public boolean matches(ScriptPath path) {
     @Override
     public ObjectTag getContext(String name) {
         return switch (name) {
-            case "gamerule" -> new ElementTag(event.getGameRule().getName(), true);
+            case "gamerule" -> new ElementTag(GameRuleReflect.getName(event.getGameRule()), true);
             case "value" -> new ElementTag(event.getValue(), true);
             case "source_type" -> getSourceType();
             case "command_block_location" -> getCommandBlock();

plugin/pom.xml

@@ -30,7 +30,7 @@
         <dependency>
             <groupId>org.spigotmc</groupId>
             <artifactId>spigot-api</artifactId>
-            <version>1.21.10-R0.1-SNAPSHOT</version>
+            <version>1.21.11-R0.1-SNAPSHOT</version>
             <type>jar</type>
             <scope>provided</scope>
         </dependency>
@@ -44,7 +44,7 @@
         <dependency>
             <groupId>net.citizensnpcs</groupId>
             <artifactId>citizens-main</artifactId>
-            <version>2.0.38-SNAPSHOT</version>
+            <version>2.0.41-SNAPSHOT</version>
             <type>jar</type>
             <scope>provided</scope>
             <exclusions>

plugin/src/main/java/com/denizenscript/denizen/objects/WorldTag.java

@@ -6,6 +6,7 @@
 import com.denizenscript.denizen.nms.abstracts.BiomeNMS;
 import com.denizenscript.denizen.utilities.BukkitImplDeprecations;
 import com.denizenscript.denizen.utilities.flags.WorldFlagHandler;
+import com.denizenscript.denizen.utilities.world.GameRuleReflect;
 import com.denizenscript.denizencore.flags.AbstractFlagTracker;
 import com.denizenscript.denizencore.flags.FlaggableObject;
 import com.denizenscript.denizencore.objects.Adjustable;
@@ -177,7 +178,7 @@ public <T> T getGameRuleOrDefault(GameRule<T> gameRule) {
         if (value == null) {
             value = world.getGameRuleDefault(gameRule);
             if (value == null) {
-                throw new IllegalStateException("World " + world_name + " contains no GameRule " + gameRule.getName());
+                throw new IllegalStateException("World " + world_name + " contains no GameRule " + GameRuleReflect.getName(gameRule));
             }
         }
         return value;
@@ -852,16 +853,19 @@ else if (time >= 12500) {
         // @returns ElementTag
         // @description
         // Returns the current value of the specified gamerule in the world.
-        // Note that the name is case-sensitive... so "doFireTick" is correct, but "dofiretick" is not.
         // -->
         registerTag(ElementTag.class, "gamerule", (attribute, object) -> {
             if (!attribute.hasParam()) {
                 attribute.echoError("The tag 'worldtag.gamerule[...]' must have an input value.");
                 return null;
             }
-            GameRule rule = GameRule.getByName(attribute.getParam());
-            Object result = object.getWorld().getGameRuleValue(rule);
-            return new ElementTag(result == null ? "null" : result.toString());
+            GameRule<?> rule = GameRuleReflect.getByName(attribute.getParam());
+            if (rule == null) {
+                attribute.echoError("Invalid game rule specified: " + attribute.getParam() + '.');
+                return null;
+            }
+            Object result = GameRuleReflect.getValue(object.getWorld(), rule);
+            return new ElementTag(String.valueOf(result), true);
         });
 
         // <--[tag]
@@ -872,10 +876,10 @@ else if (time >= 12500) {
         // -->
         registerTag(MapTag.class, "gamerule_map", (attribute, object) -> {
             MapTag map = new MapTag();
-            for (GameRule rule : GameRule.values()) {
-                Object result = object.getWorld().getGameRuleValue(rule);
+            for (GameRule<?> rule : GameRuleReflect.values()) {
+                Object result = GameRuleReflect.getValue(object.getWorld(), rule);
                 if (result != null) {
-                    map.putObject(rule.getName(), new ElementTag(result.toString()));
+                    map.putObject(GameRuleReflect.getName(rule), new ElementTag(result.toString(), true));
                 }
             }
             return map;
@@ -987,7 +991,7 @@ else if (time >= 12500) {
         // @description
         // Returns whether enough players are sleeping to prepare for the night to advance.
         // Typically used before checking <@link tag WorldTag.enough_deep_sleeping>
-        // By default, automatically checks the playersSleepingPercentage gamerule,
+        // By default, automatically checks the players_sleeping_percentage gamerule,
         // but this can optionally be overridden by specifying a percentage integer.
         // Any integer above 100 will always yield 'false'. Requires at least one player to be sleeping to return 'true'.
         // -->
@@ -1008,7 +1012,7 @@ else if (time >= 12500) {
         // @description
         // Returns whether enough players have been in bed long enough for the night to advance (generally 100 ticks).
         // Loops through all online players, so is typically used after checking <@link tag WorldTag.enough_sleeping>
-        // By default, automatically checks the playersSleepingPercentage gamerule,
+        // By default, automatically checks the players_sleeping_percentage gamerule,
         // but this can optionally be overridden by specifying a percentage integer.
         // Any integer above 100 will always yield 'false'. Requires at least one player to be sleeping to return 'true'.
         // -->
@@ -1509,7 +1513,7 @@ else if (time >= 12500) {
         // @input None
         // @description
         // Skips to the next day as if enough players slept through the night.
-        // NOTE: This ignores the doDaylightCycle gamerule!
+        // NOTE: This ignores the advance_time gamerule!
         // -->
         tagProcessor.registerMechanism("skip_night", false, (object, mechanism) -> {
             // general logic from NMS world tick
@@ -1525,7 +1529,7 @@ else if (time >= 12500) {
                 NMSHandler.worldHelper.wakeUpAllPlayers(world);
             }
             // minor change: prior to 1.18, hasStorm/isRaining was not checked
-            if (object.getGameRuleOrDefault(GameRule.DO_WEATHER_CYCLE) && world.hasStorm()) {
+            if (object.getGameRuleOrDefault(GameRuleReflect.WEATHER_CYCLE_GAMERULE) && world.hasStorm()) {
                 NMSHandler.worldHelper.clearWeather(world);
             }
         });

plugin/src/main/java/com/denizenscript/denizen/scripts/commands/world/GameRuleCommand.java

@@ -1,17 +1,18 @@
 package com.denizenscript.denizen.scripts.commands.world;
 
-import com.denizenscript.denizencore.utilities.debugging.Debug;
 import com.denizenscript.denizen.objects.WorldTag;
+import com.denizenscript.denizen.utilities.world.GameRuleReflect;
 import com.denizenscript.denizencore.exceptions.InvalidArgumentsException;
 import com.denizenscript.denizencore.objects.Argument;
 import com.denizenscript.denizencore.objects.core.ElementTag;
 import com.denizenscript.denizencore.scripts.ScriptEntry;
 import com.denizenscript.denizencore.scripts.commands.AbstractCommand;
+import com.denizenscript.denizencore.utilities.debugging.Debug;
+import com.denizenscript.denizencore.utilities.debugging.DebugInternals;
 import org.bukkit.Bukkit;
+import org.bukkit.GameRule;
 import org.bukkit.generator.WorldInfo;
 
-import java.util.stream.Collectors;
-
 public class GameRuleCommand extends AbstractCommand {
 
     public GameRuleCommand() {
@@ -31,24 +32,25 @@ public GameRuleCommand() {
     //
     // @Description
     // Sets a gamerule on the world. A list of valid gamerules can be found here: <@link url https://minecraft.wiki/w/Game_rule>
-    // Note: Be careful, gamerules are CASE SENSITIVE.
     //
     // @Tags
     // <WorldTag.gamerule[<gamerule>]>
     //
     // @Usage
     // Use to disable fire spreading in world "Adventure".
-    // - gamerule Adventure doFireTick false
+    // - gamerule Adventure fire_spread_radius_around_player 0
     //
     // @Usage
     // Use to avoid mobs from destroying blocks (creepers, endermen...) and picking items up (zombies, skeletons...) in world "Adventure".
-    // - gamerule Adventure mobGriefing false
+    // - gamerule Adventure mob_griefing false
     // -->
 
     @Override
     public void addCustomTabCompletions(TabCompletionsBuilder tab) {
-        tab.add(Bukkit.getWorlds().get(0).getGameRules());
-        tab.add(Bukkit.getWorlds().stream().map(WorldInfo::getName).collect(Collectors.toSet()));
+        for (GameRule<?> gameRule : GameRuleReflect.values()) {
+            tab.add(GameRuleReflect.getName(gameRule));
+        }
+        tab.add(Bukkit.getWorlds().stream().map(WorldInfo::getName).toList());
     }
 
     @Override
@@ -82,12 +84,37 @@ else if (!scriptEntry.hasObject("value")) {
     @Override
     public void execute(ScriptEntry scriptEntry) {
         WorldTag world = scriptEntry.getObjectTag("world");
-        ElementTag gamerule = scriptEntry.getElement("gamerule");
-        ElementTag value = scriptEntry.getElement("value");
+        ElementTag gameRuleInput = scriptEntry.getElement("gamerule");
+        ElementTag valueInput = scriptEntry.getElement("value");
         if (scriptEntry.dbCallShouldDebug()) {
-            Debug.report(scriptEntry, getName(), world, gamerule, value);
+            Debug.report(scriptEntry, getName(), world, gameRuleInput, valueInput);
+        }
+        GameRule gameRule = GameRuleReflect.getByName(gameRuleInput.asString());
+        if (gameRule == null) {
+            Debug.echoError("Invalid game rule specified: " + gameRuleInput.asString() + '.');
+            return;
+        }
+        Class<?> gameRuleType = GameRuleReflect.getType(gameRule);
+        Object convertedValue;
+        if (gameRuleType == Integer.class) {
+            if (!valueInput.isInt()) {
+                Debug.echoError("Invalid value specified: must be a number.");
+                return;
+            }
+            convertedValue = valueInput.asInt();
+        }
+        else if (gameRuleType == Boolean.class) {
+            if (!valueInput.isBoolean()) {
+                Debug.echoError("Invalid value specified: must be a boolean.");
+                return;
+            }
+            convertedValue = valueInput.asBoolean();
+        }
+        else {
+            Debug.echoError("Unrecognized game rule type '" + DebugInternals.getFullClassNameOpti(gameRuleType) + "'! Please report this to the developers.");
+            return;
         }
-        if (!world.getWorld().setGameRuleValue(gamerule.asString(), value.asString())) {
+        if (!world.getWorld().setGameRule(gameRule, convertedValue)) {
             Debug.echoError(scriptEntry, "Invalid gamerule!");
         }
     }

plugin/src/main/java/com/denizenscript/denizen/tags/core/ServerTagBase.java

@@ -14,6 +14,7 @@
 import com.denizenscript.denizen.utilities.*;
 import com.denizenscript.denizen.utilities.depends.Depends;
 import com.denizenscript.denizen.utilities.inventory.SlotHelper;
+import com.denizenscript.denizen.utilities.world.GameRuleReflect;
 import com.denizenscript.denizencore.DenizenCore;
 import com.denizenscript.denizencore.events.ScriptEvent;
 import com.denizenscript.denizencore.objects.Mechanism;
@@ -639,11 +640,7 @@ else if (param.shouldBeType(EntityTag.class)) {
         // Returns a list of all available gamerules on the server.
         // -->
         tagProcessor.registerStaticTag(ListTag.class, "gamerules", (attribute, object) -> {
-            ListTag gamerules = new ListTag();
-            for (GameRule<?> rule : GameRule.values()) {
-                gamerules.add(rule.getName());
-            }
-            return gamerules;
+            return new ListTag(Arrays.asList(GameRuleReflect.values()), gameRule -> new ElementTag(GameRuleReflect.getName(gameRule), true));
         });
 
         // <--[tag]

plugin/src/main/java/com/denizenscript/denizen/utilities/world/GameRuleReflect.java

@@ -0,0 +1,68 @@
+package com.denizenscript.denizen.utilities.world;
+
+import com.denizenscript.denizen.nms.NMSHandler;
+import com.denizenscript.denizen.nms.NMSVersion;
+import com.denizenscript.denizencore.utilities.ReflectionHelper;
+import org.bukkit.GameRule;
+import org.bukkit.World;
+
+import java.lang.invoke.MethodHandle;
+
+public class GameRuleReflect {
+
+    private static final MethodHandle GAMERULE_VALUES = ReflectionHelper.getMethodHandle(GameRule.class, "values");
+    private static final MethodHandle GAMERULE_GET_BY_NAME = ReflectionHelper.getMethodHandle(GameRule.class, "getByName", String.class);
+    private static final MethodHandle GAMERULE_GET_NAME = ReflectionHelper.getMethodHandle(GameRule.class, "getName");
+    private static final MethodHandle GAMERULE_GET_TYPE = ReflectionHelper.getMethodHandle(GameRule.class, "getType");
+
+    public static final GameRule<Boolean> WEATHER_CYCLE_GAMERULE = NMSHandler.getVersion().isAtLeast(NMSVersion.v1_21) ? GameRule.ADVANCE_WEATHER : (GameRule<Boolean>) getByName("doWeatherCycle");
+
+    public static GameRule<?>[] values() {
+        try {
+            return (GameRule<?>[]) GAMERULE_VALUES.invokeExact();
+        }
+        catch (Throwable e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public static GameRule<?> getByName(String name) {
+        try {
+            return (GameRule<?>) GAMERULE_GET_BY_NAME.invokeExact(name);
+        }
+        catch (Throwable e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public static String getName(GameRule<?> gameRule) {
+        try {
+            return (String) GAMERULE_GET_NAME.invokeExact(gameRule);
+        }
+        catch (Throwable e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public static Class<?> getType(GameRule<?> gameRule) {
+        try {
+            return (Class<?>) GAMERULE_GET_TYPE.invokeExact(gameRule);
+        }
+        catch (Throwable e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    // TODO 1.21.11: certain gamemodes (e.g. max_minecart_speed) behave badly on Spigot, need to test with Paper
+    public static <T> T getValue(World world, GameRule<T> gameRule) {
+        try {
+            return world.getGameRuleValue(gameRule);
+        }
+        catch (IllegalArgumentException e) {
+            if (e.getMessage().equals("Tried to access invalid game rule")) {
+                return null;
+            }
+            throw e;
+        }
+    }
+}

plugin/src/main/java/com/denizenscript/denizen/utilities/world/PathFinder.java

@@ -2,6 +2,7 @@
 
 import com.denizenscript.denizen.objects.LocationTag;
 import com.denizenscript.denizencore.utilities.debugging.Debug;
+import net.citizensnpcs.api.ai.NavigatorParameters;
 import net.citizensnpcs.api.astar.AStarMachine;
 import net.citizensnpcs.api.astar.pathfinder.*;
 import org.bukkit.Location;
@@ -19,7 +20,7 @@ public class PathFinder {
 
     public static List<LocationTag> getPath(Location start, Location dest) {
         VectorGoal goal = new VectorGoal(dest, 1);
-        Path plan = (Path) ASTAR.runFully(goal, new VectorNode(goal, start, new ChunkBlockSource(start, 100), new MinecraftBlockExaminer()), 50000);
+        Path plan = (Path) ASTAR.runFully(goal, new VectorNode(goal, start, new ChunkBlockSource(start, 100), new NavigatorParameters().examiner(new MinecraftBlockExaminer())), 50000);
         if (plan == null) {
             Debug.verboseLog("PathFinder: No path found from " + start + " to " + dest + " (return null)");
             return new ArrayList<>();