feat: Allow consuming click events so they do not forward to parents

feat: Allow creating two inventory composables at once, so long as one is not inside the other, explicitly deny the latter

Author: 0ffz

build.gradle.kts

@@ -32,7 +32,6 @@ dependencies {
     compileOnly(idofrontLibs.kotlinx.coroutines)
     compileOnly(idofrontLibs.minecraft.mccoroutine)
     compileOnly(idofrontLibs.kotlin.reflect)
-    compileOnly(idofrontLibs.minecraft.anvilgui)
 
     // Shaded
     api(compose.runtime) {

src/main/kotlin/com/mineinabyss/guiy/components/canvases/Anvil.kt

@@ -37,7 +37,6 @@ fun Anvil(
     val inventory: Inventory = remember(holder) {
         Bukkit.getServer().createInventory(holder, InventoryType.ANVIL, titleMM)
     }
-    holder.setActiveInventory(GuiyInventory(inventory, onClose))
 
     // Track updates to anvil text via packets
     var playerViewText by remember(inventory) { mutableStateOf("") }
@@ -54,6 +53,7 @@ fun Anvil(
 
     Inventory(
         inventory,
+        onClose = onClose,
         title = titleMM,
         modifier = constrainedModifier,
         gridToInventoryIndex = { it.x },

src/main/kotlin/com/mineinabyss/guiy/components/canvases/Chest.kt

@@ -3,7 +3,6 @@ package com.mineinabyss.guiy.components.canvases
 import androidx.compose.runtime.*
 import com.mineinabyss.guiy.components.rememberMiniMsg
 import com.mineinabyss.guiy.components.state.IntCoordinates
-import com.mineinabyss.guiy.inventory.GuiyInventory
 import com.mineinabyss.guiy.inventory.GuiyInventoryHolder
 import com.mineinabyss.guiy.inventory.InventoryCloseScope
 import com.mineinabyss.guiy.layout.Layout
@@ -68,13 +67,12 @@ fun Chest(
     }
 
     val inventory: Inventory = remember(size) {
-        Bukkit.createInventory(holder, CHEST_WIDTH * size.height, title).also {
-        }
+        Bukkit.createInventory(holder, CHEST_WIDTH * size.height, title)
     }
-    holder.setActiveInventory(GuiyInventory(inventory, onClose))
 
     Inventory(
         inventory = inventory,
+        onClose = onClose,
         title = title,
         modifier = constrainedModifier,
         gridToInventoryIndex = { (x, y) ->

src/main/kotlin/com/mineinabyss/guiy/components/canvases/Inventory.kt

@@ -1,22 +1,18 @@
 package com.mineinabyss.guiy.components.canvases
 
 import androidx.compose.runtime.*
-import com.github.shynixn.mccoroutine.bukkit.minecraftDispatcher
 import com.mineinabyss.guiy.components.state.IntCoordinates
 import com.mineinabyss.guiy.guiyPlugin
-import com.mineinabyss.guiy.inventory.GuiyCanvas
-import com.mineinabyss.guiy.inventory.LocalCanvas
-import com.mineinabyss.guiy.inventory.LocalGuiyOwner
-import com.mineinabyss.guiy.inventory.MapBackedGuiyCanvas
+import com.mineinabyss.guiy.inventory.*
 import com.mineinabyss.guiy.layout.Layout
 import com.mineinabyss.guiy.layout.Renderer
 import com.mineinabyss.guiy.layout.StaticMeasurePolicy
 import com.mineinabyss.guiy.modifiers.Modifier
+import com.mineinabyss.guiy.modifiers.click.clickable
 import com.mineinabyss.guiy.nodes.GuiyNode
 import com.mineinabyss.idofront.entities.title
-import kotlinx.coroutines.withContext
+import com.mineinabyss.idofront.messaging.injectedLogger
 import net.kyori.adventure.text.Component
-import org.bukkit.event.inventory.InventoryCloseEvent
 import org.bukkit.inventory.Inventory
 
 val LocalInventory: ProvidableCompositionLocal<Inventory> =
@@ -32,39 +28,33 @@ val LocalInventory: ProvidableCompositionLocal<Inventory> =
 @Composable
 fun Inventory(
     inventory: Inventory,
+    onClose: InventoryCloseScope.() -> Unit,
     title: Component? = null,
     modifier: Modifier = Modifier,
     gridToInventoryIndex: (IntCoordinates) -> Int?,
     inventoryIndexToGrid: (Int) -> IntCoordinates,
     content: @Composable () -> Unit,
 ) {
-    val viewers by LocalGuiyOwner.current.viewers.collectAsState()
+    val holder: GuiyInventoryHolder = LocalInventoryHolder.current
 
     // Update title
-    LaunchedEffect(title, viewers) {
+    LaunchedEffect(title) {
         if (title != null) inventory.viewers.forEach { it.openInventory.title(title) }
     }
 
-    // Manage opening inventory for new viewers or when inventory changes
-    LaunchedEffect(viewers, inventory) {
-        val oldViewers = inventory.viewers.toSet()
+    val canvas = remember { MapBackedGuiyCanvas() }
 
-        withContext(guiyPlugin.minecraftDispatcher) {
-            // Close inventory for removed viewers
-            (oldViewers - viewers).forEach {
-                it.closeInventory(InventoryCloseEvent.Reason.PLUGIN)
-            }
+    val existingInventory = runCatching { LocalInventory.current }.getOrNull()
 
-            // Open inventory for new viewers
-            (viewers - oldViewers).forEach {
-                it.closeInventory(InventoryCloseEvent.Reason.PLUGIN)
-                it.openInventory(inventory)
+    if (existingInventory != null) {
+        SideEffect {
+            guiyPlugin.injectedLogger().e {
+                "Creating inventory $inventory inside other inventory ($existingInventory), Guiy does not support this yet."
             }
         }
+        return
     }
 
-    val canvas = remember { MapBackedGuiyCanvas() }
-
     CompositionLocalProvider(
         LocalCanvas provides canvas,
         LocalInventory provides inventory
@@ -73,6 +63,8 @@ fun Inventory(
             measurePolicy = StaticMeasurePolicy,
             renderer = object : Renderer {
                 override fun GuiyCanvas.render(node: GuiyNode) {
+                    // The last inventory to render sets this state so holder can choose which inventory to open
+                    holder.setActiveInventory(GuiyInventory(inventory, onClose))
                     canvas.startRender()
                 }
 
@@ -90,7 +82,8 @@ fun Inventory(
                     }
                 }
             },
-            modifier = modifier,
+            // Consume click so only the visible inventory can process clicks
+            modifier = modifier.clickable(consumeClick = true) { },
             content = content,
         )
     }

src/main/kotlin/com/mineinabyss/guiy/components/canvases/rememberInventoryHolder.kt renamed to src/main/kotlin/com/mineinabyss/guiy/components/canvases/InventoryHolder.kt

@@ -2,6 +2,7 @@ package com.mineinabyss.guiy.components.canvases
 
 import androidx.compose.runtime.*
 import com.github.shynixn.mccoroutine.bukkit.launch
+import com.github.shynixn.mccoroutine.bukkit.minecraftDispatcher
 import com.mineinabyss.guiy.guiyPlugin
 import com.mineinabyss.guiy.inventory.GuiyInventoryHolder
 import com.mineinabyss.guiy.inventory.InventoryCloseScope
@@ -11,21 +12,42 @@ import com.mineinabyss.guiy.modifiers.click.ClickScope
 import com.mineinabyss.guiy.modifiers.drag.DragScope
 import com.mineinabyss.idofront.time.ticks
 import kotlinx.coroutines.delay
+import kotlinx.coroutines.withContext
 import org.bukkit.entity.Player
 import org.bukkit.event.Cancellable
+import org.bukkit.event.inventory.InventoryCloseEvent
 
 val LocalInventoryHolder = compositionLocalOf<GuiyInventoryHolder> { error("No local inventory holder defined") }
 
 @Composable
-fun ProvideInventoryHolder(content: @Composable () -> Unit) {
+fun InventoryHolder(content: @Composable () -> Unit) {
     val holder = rememberInventoryHolder()
-
     // Close inventory when disposing
     DisposableEffect(holder) {
         onDispose {
             guiyPlugin.launch { holder.inventory.close() }
         }
     }
+    val viewers by LocalGuiyOwner.current.viewers.collectAsState()
+    val inventory = holder.activeInventory.collectAsState().value
+
+    // Manage opening inventory for new viewers or when inventory changes
+    LaunchedEffect(viewers, inventory) {
+        val oldViewers = inventory?.inventory?.viewers?.toSet() ?: return@LaunchedEffect
+
+        withContext(guiyPlugin.minecraftDispatcher) {
+            // Close inventory for removed viewers
+            (oldViewers - viewers).forEach {
+                it.closeInventory(InventoryCloseEvent.Reason.PLUGIN)
+            }
+
+            // Open inventory for new viewers
+            (viewers - oldViewers).forEach {
+                it.closeInventory(InventoryCloseEvent.Reason.PLUGIN)
+                it.openInventory(inventory.inventory)
+            }
+        }
+    }
 
     CompositionLocalProvider(LocalInventoryHolder provides holder) {
         content()

src/main/kotlin/com/mineinabyss/guiy/inventory/GuiyOwner.kt

@@ -3,9 +3,7 @@ package com.mineinabyss.guiy.inventory
 import androidx.compose.runtime.*
 import androidx.compose.runtime.snapshots.Snapshot
 import com.github.shynixn.mccoroutine.bukkit.minecraftDispatcher
-import com.mineinabyss.guiy.components.canvases.LocalInventoryHolder
-import com.mineinabyss.guiy.components.canvases.ProvideInventoryHolder
-import com.mineinabyss.guiy.components.canvases.rememberInventoryHolder
+import com.mineinabyss.guiy.components.canvases.InventoryHolder
 import com.mineinabyss.guiy.guiyPlugin
 import com.mineinabyss.guiy.layout.LayoutNode
 import com.mineinabyss.guiy.modifiers.Constraints
@@ -22,11 +20,11 @@ import kotlin.coroutines.CoroutineContext
 import kotlin.reflect.KType
 
 data class ClickResult(
-    val cancelBukkitEvent: Boolean? = null,
+    val clickConsumed: Boolean? = null,
 ) {
     fun mergeWith(other: ClickResult) = ClickResult(
         // Prioritize true > false > null
-        cancelBukkitEvent = (cancelBukkitEvent ?: other.cancelBukkitEvent)?.or(other.cancelBukkitEvent ?: false)
+        clickConsumed = (clickConsumed ?: other.clickConsumed)?.or(other.clickConsumed == true)
     )
 }
 
@@ -130,7 +128,9 @@ class GuiyOwner(
                             val w = node.width
                             val x = if (w == 0) 0 else slot % width
                             val y = if (w == 0) 0 else slot / width
-                            acc.mergeWith(rootNode.processClick(scope, x, y))
+                            val processed = rootNode.processClick(scope, x, y)
+                            if (processed.clickConsumed == true) return processed
+                            acc.mergeWith(processed)
                         }
                     }
 
@@ -139,7 +139,7 @@ class GuiyOwner(
                     }
                 }) {
                 // A default inventory holder for most usecases
-                ProvideInventoryHolder {
+                InventoryHolder {
                     content()
                 }
             }

src/main/kotlin/com/mineinabyss/guiy/layout/LayoutNode.kt

@@ -7,7 +7,10 @@ import com.mineinabyss.guiy.components.state.ItemPositions
 import com.mineinabyss.guiy.inventory.ClickResult
 import com.mineinabyss.guiy.inventory.GuiyCanvas
 import com.mineinabyss.guiy.inventory.OffsetCanvas
-import com.mineinabyss.guiy.modifiers.*
+import com.mineinabyss.guiy.modifiers.Constraints
+import com.mineinabyss.guiy.modifiers.LayoutChangingModifier
+import com.mineinabyss.guiy.modifiers.Modifier
+import com.mineinabyss.guiy.modifiers.OnSizeChangedModifier
 import com.mineinabyss.guiy.modifiers.click.ClickModifier
 import com.mineinabyss.guiy.modifiers.click.ClickScope
 import com.mineinabyss.guiy.modifiers.drag.DragModifier
@@ -100,21 +103,26 @@ internal class LayoutNode : Measurable, Placeable, GuiyNode {
         renderer.apply { offsetCanvas?.renderAfterChildren(this@LayoutNode) }
     }
 
-    /**
-     * @return Whether no elements were clickable or any element requested the bukkit click event to be cancelled.
-     */
     fun processClick(scope: ClickScope, x: Int, y: Int): ClickResult {
-        val cancelClickEvent = get<ClickModifier>()?.run {
-            onClick.invoke(scope)
-            cancelClickEvent
-        }
-        return children
+        val childResult = children
             .filter { x in it.x until (it.x + it.width) && y in it.y until (it.y + it.height) }
-            .fold(ClickResult(cancelClickEvent)) { acc, it ->
-                acc.mergeWith(it.processClick(scope, x - it.x, y - it.y))
+            .foldRight(ClickResult()) { it, acc ->
+                val processed = it.processClick(scope, x - it.x, y - it.y)
+                if (processed.clickConsumed == true) {
+                    return processed
+                }
+                acc.mergeWith(processed)
             }
+
+        if (childResult.clickConsumed != true) get<ClickModifier>()?.run {
+            onClick.invoke(scope)
+            if (consumeClick) return ClickResult(true)
+        }
+
+        return childResult
     }
 
+
     data class DragInfo(
         val dragModifier: DragModifier,
         val itemMap: ItemPositions = ItemPositions(),

src/main/kotlin/com/mineinabyss/guiy/modifiers/click/ClickModifier.kt

@@ -4,13 +4,13 @@ import com.mineinabyss.guiy.modifiers.Modifier
 
 open class ClickModifier(
     val merged: Boolean = false,
-    val cancelClickEvent: Boolean,
+    val consumeClick: Boolean,
     val onClick: (ClickScope.() -> Unit),
 //    val allowClick: (ClickScope.() -> Boolean)
 ) : Modifier.Element<ClickModifier> {
     override fun mergeWith(other: ClickModifier) = ClickModifier(
         merged = true,
-        cancelClickEvent = cancelClickEvent || other.cancelClickEvent,
+        consumeClick = consumeClick || other.consumeClick,
         onClick = {
             if (!other.merged)
                 onClick()
@@ -25,13 +25,13 @@ open class ClickModifier(
 }
 
 fun Modifier.clickable(
-    cancelClickEvent: Boolean = true,
+    consumeClick: Boolean = false,
 //    allowClick: ClickScope.() -> Boolean = { true },
     onClick: ClickScope.() -> Unit
 ) =
     then(
         ClickModifier(
-            cancelClickEvent = cancelClickEvent,
+            consumeClick = consumeClick,
             onClick = onClick, /*allowClick = allowClick*/
         )
     )