Add onScreenHandlerClose and onPlayerClose

Author: Patbox

gradle.properties

@@ -3,15 +3,15 @@ org.gradle.jvmargs=-Xmx1G
 
 # Fabric Properties
 # check these on https://fabricmc.net/versions.html
-minecraft_version=1.21.7
-yarn_mappings=1.21.7+build.1
+minecraft_version=1.21.8
+yarn_mappings=1.21.8+build.1
 loader_version=0.16.14
 
 #Fabric api
-fabric_version=0.128.2+1.21.7
+fabric_version=0.129.0+1.21.8
 
 # Mod Properties
-mod_version = 1.10.1+1.21.7
+mod_version = 1.10.2+1.21.8
 maven_group = eu.pb4
 archives_base_name = sgui
 

src/main/java/eu/pb4/sgui/api/gui/GuiInterface.java

@@ -6,7 +6,6 @@
 import net.minecraft.screen.ScreenHandlerType;
 import net.minecraft.server.network.ServerPlayerEntity;
 import net.minecraft.text.Text;
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
 
 @SuppressWarnings({"unused"})
@@ -71,10 +70,9 @@ public interface GuiInterface {
     /**
      * Used internally for closing the gui.
      *
-     * @param alreadyClosed Is set to true, if gui's ScreenHandler is already closed
+     * @param alreadyClosed Is set to true, if gui's ScreenHandler is already closed and close packet shouldn't be sent
      * @see GuiInterface#onClose()
      */
-    @ApiStatus.Internal
     void close(boolean alreadyClosed);
 
     /**
@@ -105,11 +103,27 @@ default void onOpen() {
     }
 
     /**
-     * Executes when the screen is closed
+     * Executes when the screen is closed with GuiInterface#close
+     * Which can be called by your code or outside of it.
      */
     default void onClose() {
     }
 
+    /**
+     * Executes when the screen is closed by player
+     *
+     * @param success Whatever screen will be actually closed, or forcefully reopened. Depends on value of GuiInterface#canPlayerClose()
+     */
+    default void onPlayerClose(boolean success) {
+    }
+
+    /**
+     * Executes when the screen handler is closed.
+     * This method might be executed multiple times.
+     */
+    default void onScreenHandlerClosed() {
+    }
+
     /**
      * Executes each tick while the screen is open
      */

src/main/java/eu/pb4/sgui/api/gui/layered/BackendSimpleGui.java

@@ -29,6 +29,16 @@ public void onClose() {
         this.gui.onClose();
     }
 
+    @Override
+    public void onPlayerClose(boolean b) {
+        this.gui.onPlayerClose(false);
+    }
+
+    @Override
+    public void onScreenHandlerClosed() {
+        this.gui.onScreenHandlerClosed();
+    }
+
     @Override
     public void onTick() {
         this.gui.onTick();

src/main/java/eu/pb4/sgui/mixin/ServerPlayNetworkHandlerMixin.java

@@ -138,8 +138,10 @@ public ServerPlayNetworkHandlerMixin(MinecraftServer server, ClientConnection co
             }
 
             if (handler.getGui().canPlayerClose()) {
+                handler.getGui().onPlayerClose(true);
                 this.sgui$previousScreen = this.player.currentScreenHandler;
             } else {
+                handler.getGui().onPlayerClose(false);
                 var screenHandler = this.player.currentScreenHandler;
                 try {
                     if (screenHandler.getType() != null) {

src/main/java/eu/pb4/sgui/virtual/FakeScreenHandler.java

@@ -42,4 +42,14 @@ public void sendContentUpdates() {
     public ItemStack quickMove(PlayerEntity player, int index) {
         return ItemStack.EMPTY;
     }
+
+    @Override
+    public void onClosed(PlayerEntity player) {
+        super.onClosed(player);
+        try {
+            this.getGui().onScreenHandlerClosed();
+        } catch (Throwable e) {
+            this.getGui().handleException(e);
+        }
+    }
 }

src/main/java/eu/pb4/sgui/virtual/book/BookScreenHandler.java

@@ -85,4 +85,14 @@ protected boolean insertItem(ItemStack stack, int startIndex, int endIndex, bool
     public BookGui getGui() {
         return gui;
     }
+
+    @Override
+    public void onClosed(PlayerEntity player) {
+        super.onClosed(player);
+        try {
+            this.getGui().onScreenHandlerClosed();
+        } catch (Throwable e) {
+            this.getGui().handleException(e);
+        }
+    }
 }

src/main/java/eu/pb4/sgui/virtual/inventory/VirtualScreenHandler.java

@@ -123,4 +123,14 @@ public void setSlot(int index, Slot slot) {
     protected boolean insertItem(ItemStack stack, int startIndex, int endIndex, boolean fromLast) {
         return this.gui.insertItem(stack, startIndex, endIndex, fromLast);
     }
+
+    @Override
+    public void onClosed(PlayerEntity player) {
+        super.onClosed(player);
+        try {
+            this.getGui().onScreenHandlerClosed();
+        } catch (Throwable e) {
+            this.getGui().handleException(e);
+        }
+    }
 }