Adds support for modifying the tick rate

src/main/java/ch/njol/skript/bukkitutil/ServerUtils.java

@@ -0,0 +1,46 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.bukkitutil;
+
+import ch.njol.skript.Skript;
+import org.bukkit.Bukkit;
+import org.bukkit.ServerTickManager;
+
+public class ServerUtils {
+
+	private static final ServerTickManager SERVER_TICK_MANAGER;
+
+	static {
+		ServerTickManager serverTickManager = null;
+		if (Skript.methodExists(Bukkit.class, "getServerTickManager")) {
+			serverTickManager = Bukkit.getServerTickManager();
+		}
+		SERVER_TICK_MANAGER = serverTickManager;
+	}
+
+	public static ServerTickManager getServerTickManager() {
+		return SERVER_TICK_MANAGER;
+	}
+
+	public static boolean isServerTickManagerPresent() {
+		return SERVER_TICK_MANAGER != null;
+	}
+
+}
+

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

@@ -0,0 +1,56 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.conditions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.bukkitutil.ServerUtils;
+import ch.njol.skript.conditions.base.PropertyCondition;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import org.bukkit.Bukkit;
+import org.bukkit.entity.Entity;
+
+@Name("Is Entity Tick Frozen")
+@Description("Checks if the specified entities are frozen due to the server's ticking state.")
+@Examples("if target entity is tick frozen:")
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20.4+")
+public class CondIsTickFrozen extends PropertyCondition<Entity> {
+
+
+	static {
+		if (ServerUtils.isServerTickManagerPresent())
+			register(CondIsTickFrozen.class, "tick frozen", "entities");
+	}
+
+	@Override
+	public boolean check(Entity entity) {
+		return ServerUtils.getServerTickManager().isFrozen(entity);
+	}
+
+	@Override
+	protected String getPropertyName() {
+		return "tick frozen";
+	}
+
+}
+

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

@@ -0,0 +1,73 @@
+package ch.njol.skript.conditions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.bukkitutil.ServerUtils;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Condition;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.util.Kleenean;
+import org.bukkit.ServerTickManager;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Locale;
+
+@Name("Server Tick State")
+@Description("Represents the ticking state of the server, for example, if the server is frozen, or running normally.")
+@Examples({
+	"if server's tick state is currently frozen:",
+	"if the server is sprinting:"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20.4+")
+public class CondServerTickState extends Condition {
+
+	static {
+		if (ServerUtils.isServerTickManagerPresent())
+			Skript.registerCondition(CondServerTickState.class,
+				"[the] server's tick[ing] state is [currently] (:frozen|:stepping|:sprinting|:normal)",
+				"[the] server's tick[ing] state (isn't|is not) [currently] (:frozen|:stepping|:sprinting|:normal)");
+	}
+
+	private ServerState state;
+
+	public enum ServerState {
+		FROZEN, STEPPING, SPRINTING, NORMAL
+	}
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		String tag = parseResult.tags.get(0).toUpperCase(Locale.ENGLISH);
+		state = ServerState.valueOf(tag);
+		setNegated(matchedPattern == 1);
+		return true;
+	}
+	@Override
+	public boolean check(Event event) {
+		ServerTickManager serverTickManager = ServerUtils.getServerTickManager();
+		boolean result = switch (state) {
+			case FROZEN -> serverTickManager.isFrozen();
+			case STEPPING -> serverTickManager.isStepping();
+			case SPRINTING -> serverTickManager.isSprinting();
+			case NORMAL -> serverTickManager.isRunningNormally();
+		};
+		return isNegated() != result;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		String stateStr;
+		if (isNegated()) {
+			stateStr = "the server's tick state isn't ";
+		} else {
+			stateStr = "the server's tick state is ";
+		}
+		return stateStr + state.toString().toLowerCase(Locale.ENGLISH);
+	}
+}
+

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

@@ -0,0 +1,52 @@
+package ch.njol.skript.effects;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.bukkitutil.ServerUtils;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Effect;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.util.Kleenean;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+@Name("Freeze/Unfreeze Server")
+@Description("Freezes or unfreezes the server.")
+@Examples({
+	"freeze server",
+	"unfreeze server"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20.4+")
+public class EffFreezeServer extends Effect {
+
+	static {
+		if (ServerUtils.isServerTickManagerPresent())
+			Skript.registerEffect(EffFreezeServer.class,
+				"freeze [the] server",
+				"unfreeze [the] server");
+	}
+
+	private boolean freeze;
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		freeze = matchedPattern == 0;
+		return true;
+	}
+
+	@Override
+	protected void execute(Event event) {
+		ServerUtils.getServerTickManager().setFrozen(freeze);
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return freeze ? "freeze server" : "unfreeze server";
+	}
+
+}

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

@@ -0,0 +1,65 @@
+package ch.njol.skript.effects;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.bukkitutil.ServerUtils;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Effect;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.util.Timespan;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.util.Kleenean;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+@Name("Sprint Server")
+@Description({
+	"Makes the server sprint for a certain amount of time, or stops the server from sprinting.",
+	"Sprinting is where the server increases the tick rate depending on the time you input, and resets the tick rate to what it was after the server has finished sprinting."
+})
+@Examples({
+	"request server to sprint for 10 seconds",
+	"make server stop sprinting"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20.4+")
+public class EffSprintServer extends Effect {
+
+	static {
+		if (ServerUtils.isServerTickManagerPresent())
+			Skript.registerEffect(EffSprintServer.class,
+				"make [the] server sprint for %timespan%",
+				"make [the] server stop sprinting");
+	}
+
+	private Expression<Timespan> timespan;
+
+	@Override
+	@SuppressWarnings("unchecked")
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		if (matchedPattern == 0)
+			timespan = (Expression<Timespan>) exprs[0];
+		return true;
+	}
+
+	@Override
+	protected void execute(Event event) {
+		if (timespan != null) {
+			long sprintTicks = timespan.getOptionalSingle(event).map(Timespan::getTicks).orElse(1L);
+			ServerUtils.getServerTickManager().requestGameToSprint((int) sprintTicks);
+		} else {
+			ServerUtils.getServerTickManager().stopSprinting();
+		}
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		if (timespan != null)
+			return "make the server sprint for " + timespan.toString(event, debug);
+		return "make the server stop sprinting";
+	}
+
+}

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

@@ -0,0 +1,66 @@
+package ch.njol.skript.effects;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.bukkitutil.ServerUtils;
+import ch.njol.skript.doc.RequiredPlugins;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Effect;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.util.Timespan;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.util.Kleenean;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+
+@Name("Step Server")
+@Description({
+	"Makes the server \"step\" for a certain amount of time",
+	"The server can only step when its ticking state is frozen.",
+	"When stepping, the server goes forward that amount of time in ticks."
+})
+@Examples({
+	"make server step for 5 seconds",
+	"make server stop stepping"
+})
+@Since("INSERT VERSION")
+@RequiredPlugins("Minecraft 1.20.4+")
+public class EffStepServer extends Effect {
+
+	static {
+		if (ServerUtils.isServerTickManagerPresent())
+			Skript.registerEffect(EffStepServer.class,
+				"make [the] server step for %timespan%",
+				"make [the] server stop stepping");
+	}
+
+	private Expression<Timespan> timespan;
+
+	@Override
+	@SuppressWarnings("unchecked")
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		if (matchedPattern == 0)
+			timespan = (Expression<Timespan>) exprs[0];
+		return true;
+	}
+
+	@Override
+	protected void execute(Event event) {
+		if (timespan != null) {
+			Timespan timespan = this.timespan.getSingle(event);
+			if (timespan != null)
+				ServerUtils.getServerTickManager().stepGameIfFrozen((int) timespan.getTicks());
+		} else {
+			ServerUtils.getServerTickManager().stopStepping();
+		}
+	}
+
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return timespan == null ? "make the server stop stepping" : "make the server step for " + timespan.toString(event, debug);
+	}
+
+}