improved unformed, improve simple multiblock

Author: JustAHuman-xD

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/block/MultiblockCache.kt

@@ -66,12 +66,15 @@ internal object MultiblockCache : Listener {
         override fun run() {
             for (multiblockPosition in dirtyMultiblocks) {
                 // For a multiblock to be formed, it must be fully loaded
+                val multiblock = BlockStorage.getAs<PylonMultiblock>(multiblockPosition)
                 if (multiblockPosition !in fullyLoadedMultiblocks) {
-                    formedMultiblocks.remove(multiblockPosition)
+                    if (formedMultiblocks.remove(multiblockPosition) && multiblock != null) {
+                        multiblock.onMultiblockUnformed(true)
+                        PylonMultiblockUnformEvent(multiblockPosition.block, multiblock as PylonBlock).callEvent()
+                    }
                     continue
                 }
 
-                val multiblock = BlockStorage.getAs<PylonMultiblock>(multiblockPosition)
                 if (multiblock != null && multiblock.checkFormed()) {
                     if (formedMultiblocks.add(multiblockPosition)) {
                         multiblock.onMultiblockFormed()
@@ -82,7 +85,7 @@ internal object MultiblockCache : Listener {
                     }
                 } else {
                     if (formedMultiblocks.remove(multiblockPosition) && multiblock != null) {
-                        multiblock.onMultiblockUnformed()
+                        multiblock.onMultiblockUnformed(false)
                         PylonMultiblockUnformEvent(multiblockPosition.block, multiblock as PylonBlock).callEvent()
                     }
                 }
@@ -99,13 +102,17 @@ internal object MultiblockCache : Listener {
         = dirtyMultiblocks.add(multiblock.block.position)
 
     private fun refreshFullyLoaded(multiblock: PylonMultiblock) {
+        val multiblockPosition = multiblock.block.position
         if (multiblock.chunksOccupied.all { it.isLoaded }) {
-            fullyLoadedMultiblocks.add(multiblock.block.position)
+            fullyLoadedMultiblocks.add(multiblockPosition)
             markDirty(multiblock)
         } else {
-            formedMultiblocks.remove(multiblock.block.position)
-            fullyLoadedMultiblocks.remove(multiblock.block.position)
-            dirtyMultiblocks.remove(multiblock.block.position)
+            if (formedMultiblocks.remove(multiblockPosition)) {
+                multiblock.onMultiblockUnformed(true)
+                PylonMultiblockUnformEvent(multiblock.block, multiblock as PylonBlock).callEvent()
+            }
+            fullyLoadedMultiblocks.remove(multiblockPosition)
+            dirtyMultiblocks.remove(multiblockPosition)
         }
     }
 
@@ -127,8 +134,8 @@ internal object MultiblockCache : Listener {
             }
         }
 
-        fullyLoadedMultiblocks.remove(multiblockPosition)
         formedMultiblocks.remove(multiblockPosition)
+        fullyLoadedMultiblocks.remove(multiblockPosition)
         dirtyMultiblocks.remove(multiblockPosition)
     }
 
@@ -162,19 +169,23 @@ internal object MultiblockCache : Listener {
 
     @EventHandler
     private fun handle(event: PylonChunkBlocksUnloadEvent) {
-        // Mark existing multiblocks with components as not formed and not fully loaded
-        for (multiblockPosition in loadedMultiblocksWithComponentsInChunk(event.chunk.position)) {
-            formedMultiblocks.remove(multiblockPosition)
-            fullyLoadedMultiblocks.remove(multiblockPosition)
-            dirtyMultiblocks.remove(multiblockPosition)
-        }
-
         // Remove multiblocks that were just unloaded
         for (pylonBlock in event.pylonBlocks) {
             if (pylonBlock is PylonMultiblock) {
                 onMultiblockRemoved(pylonBlock)
             }
         }
+
+        // Mark existing multiblocks with components as not formed and not fully loaded
+        for (multiblockPosition in loadedMultiblocksWithComponentsInChunk(event.chunk.position)) {
+            val multiblock = BlockStorage.getAs<PylonMultiblock>(multiblockPosition)
+            if (formedMultiblocks.remove(multiblockPosition) && multiblock != null) {
+                multiblock.onMultiblockUnformed(true)
+                PylonMultiblockUnformEvent(multiblockPosition.block, multiblock as PylonBlock).callEvent()
+            }
+            fullyLoadedMultiblocks.remove(multiblockPosition)
+            dirtyMultiblocks.remove(multiblockPosition)
+        }
     }
 
     @EventHandler

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/block/base/PylonMultiblock.kt

@@ -4,7 +4,6 @@ import io.github.pylonmc.pylon.core.block.MultiblockCache
 import io.github.pylonmc.pylon.core.util.position.ChunkPosition
 import org.bukkit.block.Block
 import org.jetbrains.annotations.ApiStatus
-import org.jetbrains.annotations.MustBeInvokedByOverriders
 
 
 /**
@@ -70,7 +69,12 @@ interface PylonMultiblock {
 
     /**
      * Called when the multiblock is unformed (i.e., was formed before, but now is not).
-     * This includes when a part of the multiblock is unloaded, and the multiblock becomes unformed because of it.
+     * This includes when a part of the multiblock is unloaded and the multiblock becomes unformed because of it,
+     * or when part of the multiblock is broken/changed, and it becomes unformed because of it.
+     *
+     * This is **not** called when the multiblock itself is unloaded, use [PylonUnloadBlock] for that.
+     *
+     * [partUnloaded] is true if the multiblock became unformed because part of it was unloaded, false otherwise.
      */
-    fun onMultiblockUnformed() {}
+    fun onMultiblockUnformed(partUnloaded: Boolean) {}
 }

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/block/base/PylonSimpleMultiblock.kt

@@ -9,7 +9,6 @@ import io.github.pylonmc.pylon.core.datatypes.PylonSerializers
 import io.github.pylonmc.pylon.core.entity.EntityStorage
 import io.github.pylonmc.pylon.core.entity.PylonEntity
 import io.github.pylonmc.pylon.core.entity.base.PylonInteractEntity
-import io.github.pylonmc.pylon.core.entity.display.BlockDisplayBuilder
 import io.github.pylonmc.pylon.core.entity.display.ItemDisplayBuilder
 import io.github.pylonmc.pylon.core.entity.display.transform.TransformBuilder
 import io.github.pylonmc.pylon.core.event.PylonBlockDeserializeEvent
@@ -28,7 +27,6 @@ import org.bukkit.Material
 import org.bukkit.NamespacedKey
 import org.bukkit.block.Block
 import org.bukkit.block.BlockFace
-import org.bukkit.entity.BlockDisplay
 import org.bukkit.entity.ItemDisplay
 import org.bukkit.event.EventHandler
 import org.bukkit.event.Listener
@@ -37,6 +35,7 @@ import org.bukkit.inventory.ItemStack
 import org.bukkit.persistence.PersistentDataContainer
 import org.bukkit.util.Vector
 import org.jetbrains.annotations.ApiStatus
+import org.jetbrains.annotations.MustBeInvokedByOverriders
 import org.joml.Vector3i
 import java.util.IdentityHashMap
 import java.util.UUID
@@ -219,8 +218,10 @@ interface PylonSimpleMultiblock : PylonMultiblock, PylonEntityHolderBlock, Pylon
         val rotatedComponents = if (facing == null) components else rotateComponentsToFace(components, facing)
         for ((offset, component) in rotatedComponents) {
             val key = "multiblock_ghost_block_${offset.x}_${offset.y}_${offset.z}"
-            val ghostBlock = component.spawnGhostBlock((block.position + offset).block)
-            heldEntities[key] = ghostBlock
+            if (!isHeldEntityPresent(key)) {
+                val ghostBlock = component.spawnGhostBlock((block.position + offset).block)
+                heldEntities[key] = ghostBlock
+            }
         }
         updateGhostBlockColors()
     }
@@ -274,20 +275,27 @@ interface PylonSimpleMultiblock : PylonMultiblock, PylonEntityHolderBlock, Pylon
             }
         }
 
-        // Remove ghosts if fully formed
-        if (formed) {
-            val toRemove = heldEntities.keys.filter { it.startsWith("multiblock_ghost_block_") }
-            for (key in toRemove) {
-                EntityStorage.get(heldEntities[key]!!)!!.entity.remove()
-                heldEntities.remove(key)
-            }
-        }
-
         updateGhostBlockColors()
 
         return formed
     }
 
+    @MustBeInvokedByOverriders
+    override fun onMultiblockFormed() {
+        val toRemove = heldEntities.keys.filter { it.startsWith("multiblock_ghost_block_") }
+        for (key in toRemove) {
+            EntityStorage.get(heldEntities[key]!!)!!.entity.remove()
+            heldEntities.remove(key)
+        }
+    }
+
+    @MustBeInvokedByOverriders
+    override fun onMultiblockUnformed(partUnloaded: Boolean) {
+        if (!partUnloaded) {
+            spawnGhostBlocks()
+        }
+    }
+
     override fun isPartOfMultiblock(otherBlock: Block): Boolean = validStructures().any {
         it.contains((otherBlock.position - block.position).vector3i)
     }