fix(26.1+): Fix OpenScreenEvent overwriting new screens from other mods #256

Author: BlayTheNinth

common/src/main/java/net/blay09/mods/balm/client/platform/event/callback/ScreenCallback.java

@@ -5,6 +5,7 @@
 import net.minecraft.client.gui.screens.Screen;
 import net.minecraft.client.input.KeyEvent;
 import net.minecraft.client.input.MouseButtonEvent;
+import org.jspecify.annotations.Nullable;
 
 public interface ScreenCallback {
     @FunctionalInterface
@@ -18,7 +19,7 @@ interface Render {
 
     @FunctionalInterface
     interface Opening {
-        Screen modifyScreen(Screen screen);
+        @Nullable Screen modifyScreen(@Nullable Screen screen);
 
         EventMapper<Opening> EVENT = EventMapper.createUnbound("ScreenCallback.Opening");
     }

fabric/src/main/java/net/blay09/mods/balm/fabric/internal/mixin/MinecraftMixin.java

@@ -31,7 +31,7 @@ public class MinecraftMixin {
     public ClientLevel level;
 
     @ModifyVariable(method = "setScreen(Lnet/minecraft/client/gui/screens/Screen;)V", at = @At(value = "FIELD", target = "Lnet/minecraft/client/Minecraft;screen:Lnet/minecraft/client/gui/screens/Screen;", opcode = Opcodes.GETFIELD, shift = At.Shift.AFTER), argsOnly = true)
-    public Screen modifyScreen(Screen screen) {
+    public @Nullable Screen modifyScreen(Screen screen) {
         return FabricBalmSupplementalClientEvents.SCREEN_OPEN.invoker().modifyScreen(screen);
     }
 

forge/src/main/java/net/blay09/mods/balm/forge/client/event/internal/ForgeBalmClientEventMappings.java

@@ -32,10 +32,8 @@ public static void bind() {
         ScreenCallback.Init.After.EVENT.configureMapping(ForgeBalmSupplementalClientEvents.SCREEN_INIT_POST::register);
         ScreenCallback.Opening.EVENT.configureMapping((phase, it)
                 -> ScreenEvent.Opening.BUS.addListener(mapPriority(phase), (orig) -> {
-            final var newScreen = it.modifyScreen(orig.getScreen());
-            if (newScreen != null) {
-                orig.setNewScreen(newScreen);
-            }
+            //noinspection DataFlowIssue // javadocs say "may be null"
+            orig.setNewScreen(it.modifyScreen(orig.getNewScreen()));
             return false;
         }));
         bindSimple(ScreenCallback.Render.BEFORE, ScreenEvent.Render.Pre.BUS, (event, it) -> it.render(event.getScreen(), event.getGuiGraphics(), event.getMouseX(), event.getMouseY(), event.getPartialTick()));

neoforge/src/main/java/net/blay09/mods/balm/neoforge/client/platform/event/internal/NeoForgeBalmClientEventMappings.java

@@ -1,7 +1,7 @@
 package net.blay09.mods.balm.neoforge.client.platform.event.internal;
 
-import net.blay09.mods.balm.client.platform.event.internal.BalmSupplementalClientEvents;
 import net.blay09.mods.balm.client.platform.event.callback.*;
+import net.blay09.mods.balm.client.platform.event.internal.BalmSupplementalClientEvents;
 import net.blay09.mods.balm.neoforge.platform.event.internal.NeoForgeBalmEventMappings;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.multiplayer.ClientLevel;
@@ -32,12 +32,7 @@ public static void bind() {
 
         ScreenCallback.Init.Before.EVENT.configureMapping(NeoForgeBalmSupplementalClientEvents.SCREEN_INIT_PRE::register);
         ScreenCallback.Init.After.EVENT.configureMapping(NeoForgeBalmSupplementalClientEvents.SCREEN_INIT_POST::register);
-        bindSimple(ScreenCallback.Opening.EVENT, ScreenEvent.Opening.class, (event, it) -> {
-            final var newScreen = it.modifyScreen(event.getScreen());
-            if (newScreen != null) {
-                event.setNewScreen(newScreen);
-            }
-        });
+        bindSimple(ScreenCallback.Opening.EVENT, ScreenEvent.Opening.class, (event, it) -> event.setNewScreen(it.modifyScreen(event.getNewScreen())));
 
         bindSimple(ScreenCallback.Render.BEFORE, ScreenEvent.Render.Pre.class, (event, it) -> it.render(event.getScreen(), event.getGuiGraphics(), event.getMouseX(), event.getMouseY(), event.getPartialTick()));
         bindSimple(ScreenCallback.Render.AFTER_BACKGROUND, ScreenEvent.Render.Background.class, (event, it) -> it.render(event.getScreen(), event.getGuiGraphics(), event.getMouseX(), event.getMouseY(), event.getPartialTick()));