From 41c88f6e5263b542250b6b9a7338800ddb8569b7 Mon Sep 17 00:00:00 2001 From: Joseph Tarbit Date: Sun, 6 Mar 2022 14:42:58 +0000 Subject: [PATCH] Provide access to the haveTime supplier in WorldTickEvent and ServerTickEvent (#8470) --- .../server/MinecraftServer.java.patch | 8 +-- .../event/ForgeEventFactory.java | 53 ++++++++++++++++-- .../net/minecraftforge/event/TickEvent.java | 54 +++++++++++++++++++ 3 files changed, 107 insertions(+), 8 deletions(-) diff --git a/patches/minecraft/net/minecraft/server/MinecraftServer.java.patch b/patches/minecraft/net/minecraft/server/MinecraftServer.java.patch index 68c3dff78d..9e85cbfc19 100644 --- a/patches/minecraft/net/minecraft/server/MinecraftServer.java.patch +++ b/patches/minecraft/net/minecraft/server/MinecraftServer.java.patch @@ -88,7 +88,7 @@ public void m_5705_(BooleanSupplier p_129871_) { long i = Util.m_137569_(); -+ net.minecraftforge.event.ForgeEventFactory.onPreServerTick(); ++ net.minecraftforge.event.ForgeEventFactory.onPreServerTick(p_129871_); ++this.f_129766_; this.m_5703_(p_129871_); if (i - this.f_129724_ >= 5000000000L) { @@ -104,7 +104,7 @@ long i1 = Util.m_137569_(); this.f_129735_.m_13755_(i1 - i); this.f_129754_.m_7238_(); -+ net.minecraftforge.event.ForgeEventFactory.onPostServerTick(); ++ net.minecraftforge.event.ForgeEventFactory.onPostServerTick(p_129871_); } public void m_5703_(BooleanSupplier p_129954_) { @@ -122,7 +122,7 @@ } this.f_129754_.m_6180_("tick"); -+ net.minecraftforge.event.ForgeEventFactory.onPreWorldTick(serverlevel); ++ net.minecraftforge.event.ForgeEventFactory.onPreWorldTick(serverlevel, p_129954_); try { serverlevel.m_8793_(p_129954_); @@ -130,7 +130,7 @@ serverlevel.m_6026_(crashreport); throw new ReportedException(crashreport); } -+ net.minecraftforge.event.ForgeEventFactory.onPostWorldTick(serverlevel); ++ net.minecraftforge.event.ForgeEventFactory.onPostWorldTick(serverlevel, p_129954_); this.f_129754_.m_7238_(); this.f_129754_.m_7238_(); diff --git a/src/main/java/net/minecraftforge/event/ForgeEventFactory.java b/src/main/java/net/minecraftforge/event/ForgeEventFactory.java index 9369656c0c..869b9ab4a9 100644 --- a/src/main/java/net/minecraftforge/event/ForgeEventFactory.java +++ b/src/main/java/net/minecraftforge/event/ForgeEventFactory.java @@ -7,6 +7,7 @@ package net.minecraftforge.event; import java.io.File; import java.util.*; +import java.util.function.BooleanSupplier; import java.util.function.Consumer; import javax.annotation.Nonnull; @@ -848,14 +849,36 @@ public class ForgeEventFactory MinecraftForge.EVENT_BUS.post(new TickEvent.PlayerTickEvent(TickEvent.Phase.END, player)); } + /** + * TODO: Remove in 1.19 + * + * @deprecated Use {@link #onPreWorldTick(Level, BooleanSupplier)} + */ + @Deprecated(forRemoval = true, since = "1.18.1") public static void onPreWorldTick(Level level) { - MinecraftForge.EVENT_BUS.post(new TickEvent.WorldTickEvent(LogicalSide.SERVER, TickEvent.Phase.START, level)); + onPreWorldTick(level, () -> false); } + public static void onPreWorldTick(Level level, BooleanSupplier haveTime) + { + MinecraftForge.EVENT_BUS.post(new TickEvent.WorldTickEvent(LogicalSide.SERVER, TickEvent.Phase.START, level, haveTime)); + } + + /** + * TODO: Remove in 1.19 + * + * @deprecated Use {@link #onPostWorldTick(Level, BooleanSupplier)} + */ + @Deprecated(forRemoval = true, since = "1.18.1") public static void onPostWorldTick(Level level) { - MinecraftForge.EVENT_BUS.post(new TickEvent.WorldTickEvent(LogicalSide.SERVER, TickEvent.Phase.END, level)); + onPostWorldTick(level, () -> false); + } + + public static void onPostWorldTick(Level level, BooleanSupplier haveTime) + { + MinecraftForge.EVENT_BUS.post(new TickEvent.WorldTickEvent(LogicalSide.SERVER, TickEvent.Phase.END, level, haveTime)); } public static void onPreClientTick() @@ -868,13 +891,35 @@ public class ForgeEventFactory MinecraftForge.EVENT_BUS.post(new TickEvent.ClientTickEvent(TickEvent.Phase.END)); } + /** + * TODO: Remove in 1.19 + * + * @deprecated Use {@link #onPreServerTick(BooleanSupplier)} + */ + @Deprecated(forRemoval = true, since = "1.18.1") public static void onPreServerTick() { - MinecraftForge.EVENT_BUS.post(new TickEvent.ServerTickEvent(TickEvent.Phase.START)); + onPreServerTick(() -> false); } + public static void onPreServerTick(BooleanSupplier haveTime) + { + MinecraftForge.EVENT_BUS.post(new TickEvent.ServerTickEvent(TickEvent.Phase.START, haveTime)); + } + + /** + * TODO: Remove in 1.19 + * + * @deprecated Use {@link #onPostServerTick(BooleanSupplier)} + */ + @Deprecated(forRemoval = true, since = "1.18.1") public static void onPostServerTick() { - MinecraftForge.EVENT_BUS.post(new TickEvent.ServerTickEvent(TickEvent.Phase.END)); + onPostServerTick(() -> false); + } + + public static void onPostServerTick(BooleanSupplier haveTime) + { + MinecraftForge.EVENT_BUS.post(new TickEvent.ServerTickEvent(TickEvent.Phase.END, haveTime)); } } diff --git a/src/main/java/net/minecraftforge/event/TickEvent.java b/src/main/java/net/minecraftforge/event/TickEvent.java index db3ffc37d9..dbdf128011 100644 --- a/src/main/java/net/minecraftforge/event/TickEvent.java +++ b/src/main/java/net/minecraftforge/event/TickEvent.java @@ -6,6 +6,9 @@ package net.minecraftforge.event; import net.minecraft.world.entity.player.Player; + +import java.util.function.BooleanSupplier; + import net.minecraft.server.level.ServerPlayer; import net.minecraft.world.level.Level; import net.minecraftforge.eventbus.api.Event; @@ -31,9 +34,34 @@ public class TickEvent extends Event } public static class ServerTickEvent extends TickEvent { + + private final BooleanSupplier haveTime; + + /** + * TODO: Remove in 1.19 + * + * @deprecated Use {@link ServerTickEvent#ServerTickEvent(Phase, BooleanSupplier)} + */ + @Deprecated(forRemoval = true, since = "1.18.1") public ServerTickEvent(Phase phase) + { + this(phase, () -> false); + } + + public ServerTickEvent(Phase phase, BooleanSupplier haveTime) { super(Type.SERVER, LogicalSide.SERVER, phase); + this.haveTime = haveTime; + } + + /** + * @return {@code true} whether the server has enough time to perform any + * additional tasks (usually IO related) during the current tick, + * otherwise {@code false} + */ + public boolean haveTime() + { + return this.haveTime.getAsBoolean(); } } @@ -46,10 +74,36 @@ public class TickEvent extends Event public static class WorldTickEvent extends TickEvent { public final Level world; + private final BooleanSupplier haveTime; + + /** + * TODO: Remove in 1.19 + * + * @deprecated Use {@link WorldTickEvent#WorldTickEvent(LogicalSide, Phase, Level, BooleanSupplier)} + */ + @Deprecated(forRemoval = true, since = "1.18.1") public WorldTickEvent(LogicalSide side, Phase phase, Level world) + { + this(side, phase, world, () -> false); + } + + public WorldTickEvent(LogicalSide side, Phase phase, Level world, BooleanSupplier haveTime) { super(Type.WORLD, side, phase); this.world = world; + this.haveTime = haveTime; + } + + /** + * @return {@code true} whether the server has enough time to perform any + * additional tasks (usually IO related) during the current tick, + * otherwise {@code false} + * + * @see ServerTickEvent#haveTime() + */ + public boolean haveTime() + { + return this.haveTime.getAsBoolean(); } } public static class PlayerTickEvent extends TickEvent {