Merge pull request #635 from pylonmc/idra/new-drills

Multiblock utils

Author: LordIdra

rebar/src/main/kotlin/io/github/pylonmc/rebar/block/base/RebarSimpleMultiblock.kt

@@ -9,7 +9,6 @@ import io.github.pylonmc.rebar.block.RebarBlockSchema
 import io.github.pylonmc.rebar.datatypes.RebarSerializers
 import io.github.pylonmc.rebar.entity.EntityStorage
 import io.github.pylonmc.rebar.entity.RebarEntity
-import io.github.pylonmc.rebar.entity.base.RebarInteractEntity
 import io.github.pylonmc.rebar.entity.display.BlockDisplayBuilder
 import io.github.pylonmc.rebar.entity.display.ItemDisplayBuilder
 import io.github.pylonmc.rebar.entity.display.transform.TransformBuilder
@@ -19,10 +18,12 @@ import io.github.pylonmc.rebar.event.RebarBlockSerializeEvent
 import io.github.pylonmc.rebar.event.RebarBlockUnloadEvent
 import io.github.pylonmc.rebar.item.builder.ItemStackBuilder
 import io.github.pylonmc.rebar.registry.RebarRegistry
+import io.github.pylonmc.rebar.util.getRelative
 import io.github.pylonmc.rebar.util.position.ChunkPosition
 import io.github.pylonmc.rebar.util.position.position
 import io.github.pylonmc.rebar.util.rebarKey
 import io.github.pylonmc.rebar.util.rotateVectorToFace
+import io.github.pylonmc.rebar.waila.Waila
 import io.github.pylonmc.rebar.waila.WailaDisplay
 import kotlinx.coroutines.delay
 import net.kyori.adventure.text.Component
@@ -38,7 +39,6 @@ import org.bukkit.entity.ItemDisplay
 import org.bukkit.entity.Player
 import org.bukkit.event.EventHandler
 import org.bukkit.event.Listener
-import org.bukkit.event.player.PlayerInteractEntityEvent
 import org.bukkit.persistence.PersistentDataContainer
 import org.bukkit.util.Vector
 import org.jetbrains.annotations.ApiStatus
@@ -89,6 +89,14 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
     interface MultiblockComponent {
         fun matches(block: Block): Boolean
 
+        /**
+         * Sets [block] to a 'default' value which matches this MultiblockComponent.
+         *
+         * For example, if a MultiblockComponent can be grass or dirt, this should set
+         * the block to either grass or dirt
+         */
+        fun placeDefaultBlock(block: Block)
+
         companion object {
 
             @JvmStatic
@@ -147,6 +155,12 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
 
         override fun matches(block: Block): Boolean = !BlockStorage.isRebarBlock(block) && block.type in materials
 
+        override fun placeDefaultBlock(block: Block) {
+            if (block.type.isAir && !BlockStorage.isRebarBlock(block)) {
+                block.type = materials.first()
+            }
+        }
+
         override fun spawnGhostBlock(block: Block): UUID {
             val blockDataList = blockDataList()
             val display = BlockDisplayBuilder()
@@ -215,6 +229,12 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
             return false
         }
 
+        override fun placeDefaultBlock(block: Block) {
+            if (block.type.isAir && !BlockStorage.isRebarBlock(block)) {
+                block.blockData = blockDatas.first()
+            }
+        }
+
         override fun spawnGhostBlock(block: Block): UUID {
             val stringDatas: List<String> = blockDatas.map { it.getAsString(true) }
             val display = BlockDisplayBuilder()
@@ -265,6 +285,10 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
             return false
         }
 
+        override fun placeDefaultBlock(block: Block) {
+            multiblockComponents.first().placeDefaultBlock(block)
+        }
+
         override fun spawnGhostBlocks(block: Block): List<UUID> {
             var blockDisplay: BlockDisplay? = null
             var itemDisplay: ItemDisplay? = null
@@ -353,6 +377,12 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
 
         override fun matches(block: Block): Boolean = BlockStorage.get(block)?.schema?.key == key
 
+        override fun placeDefaultBlock(block: Block) {
+            if (block.type.isAir && !BlockStorage.isRebarBlock(block)) {
+                BlockStorage.placeBlock(block, key)
+            }
+        }
+
         override fun spawnGhostBlock(block: Block): UUID {
             val schema = schema()
             val display = ItemDisplayBuilder()
@@ -377,6 +407,11 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
      */
     val components: Map<Vector3i, MultiblockComponent>
 
+    /**
+     * Automatically implemented by RebarBlock
+     */
+    fun getWaila(player: Player): WailaDisplay?
+
     /**
      * Sets the 'direction' we expect the multiblock to be built in. North is considered the default facing direction -
      * ie setFacing(BlockFace.NORTH) will preserve the original multiblock structure without rotating it.
@@ -471,6 +506,27 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
     val maxCorner: Vector3i
         get() = Vector3i(horizontalRadius, components.keys.maxOf { it.y }, horizontalRadius)
 
+    fun getMultiblockBlock(position: Vector3i): Block {
+        val direction = getMultiblockDirection()
+        return if (direction != null) {
+            block.getRelative(rotateVectorToFace(position, direction))
+        } else {
+            block.getRelative(position)
+        }
+    }
+
+    fun getMultiblockComponent(position: Vector3i) =
+        BlockStorage.get(getMultiblockBlock(position))
+
+    fun <T> getMultiblockComponent(clazz: Class<T>, position: Vector3i) =
+        BlockStorage.getAs(clazz, getMultiblockBlock(position))
+
+    fun getMultiblockComponentOrThrow(position: Vector3i) =
+        getMultiblockComponent(position) ?: throw IllegalStateException("There is no Rebar block at $position")
+
+    fun <T> getMultiblockComponentOrThrow(clazz: Class<T>, position: Vector3i) =
+        getMultiblockComponent(clazz, position) ?: throw IllegalStateException("There is no Rebar block at $position or it is not of type $clazz")
+
     override val chunksOccupied: Set<ChunkPosition>
         get() {
             val chunks = mutableSetOf<ChunkPosition>()
@@ -505,13 +561,19 @@ interface RebarSimpleMultiblock : RebarMultiblock, RebarEntityHolderBlock, Rebar
             EntityStorage.get(heldEntities[key]!!)!!.entity.remove()
             heldEntities.remove(key)
         }
+        for (position in components.keys) {
+            Waila.addWailaOverride(getMultiblockBlock(position), this::getWaila)
+        }
     }
 
     @MustBeInvokedByOverriders
     override fun onMultiblockUnformed(partUnloaded: Boolean) {
         if (!partUnloaded) {
             spawnGhostBlocks()
         }
+        for (position in components.keys) {
+            Waila.removeWailaOverride(getMultiblockBlock(position))
+        }
     }
 
     override fun isPartOfMultiblock(otherBlock: Block): Boolean = validStructures().any {

rebar/src/main/kotlin/io/github/pylonmc/rebar/command/RebarCommand.kt

@@ -12,6 +12,7 @@ import io.github.pylonmc.rebar.Rebar
 import io.github.pylonmc.rebar.addon.RebarAddon
 import io.github.pylonmc.rebar.block.BlockStorage
 import io.github.pylonmc.rebar.block.RebarBlockSchema
+import io.github.pylonmc.rebar.block.base.RebarSimpleMultiblock
 import io.github.pylonmc.rebar.content.debug.DebugWaxedWeatheredCutCopperStairs
 import io.github.pylonmc.rebar.content.guide.RebarGuide
 import io.github.pylonmc.rebar.entity.display.transform.Rotation
@@ -464,6 +465,36 @@ private val setphantom = buildCommand("setphantom") {
     }
 }
 
+private val finishMultiblock = buildCommand("finishmultiblock") {
+    permission("rebar.command.finishmultiblock")
+    executesWithPlayer { player ->
+        RebarMetrics.onCommandRun("/rb finishmultiblock")
+
+        val multiblock = player.getTargetBlockExact(5)?.let {
+            BlockStorage.getAs<RebarSimpleMultiblock>(it)
+        }
+        if (multiblock == null) {
+            player.sendFeedback("finishmultiblock.failed")
+            return@executesWithPlayer
+        }
+
+        for ((position, block) in multiblock.components) {
+            block.placeDefaultBlock(multiblock.getMultiblockBlock(position))
+        }
+
+        // finish sub-multiblocks (e.g. hatches)
+        for ((position, block) in multiblock.components) {
+            BlockStorage.getAs<RebarSimpleMultiblock>(multiblock.getMultiblockBlock(position))?.let { subMultiblock ->
+                for ((position, block) in subMultiblock.components) {
+                    block.placeDefaultBlock(subMultiblock.getMultiblockBlock(position))
+                }
+            }
+        }
+
+        player.sendFeedback("finishmultiblock.success")
+    }
+}
+
 @JvmSynthetic
 internal val ROOT_COMMAND = buildCommand("rebar") {
     permission("rebar.command.guide")
@@ -482,6 +513,7 @@ internal val ROOT_COMMAND = buildCommand("rebar") {
     then(research)
     then(exposeRecipeConfig)
     then(confetti)
+    then(finishMultiblock)
 }
 
 @JvmSynthetic

rebar/src/main/kotlin/io/github/pylonmc/rebar/util/RebarUtils.kt

@@ -611,4 +611,6 @@ fun getBlockBreakTicks(tool: ItemStack, block: Block)
 /**
  * Schedules the entity to be removed next tick
  */
-fun Entity.scheduleRemove() = Bukkit.getScheduler().runTask(Rebar, this::remove)
+fun Entity.scheduleRemove() = Bukkit.getScheduler().runTask(Rebar, this::remove)
+
+fun Block.getRelative(vector: Vector3i) = this.getRelative(vector.x, vector.y, vector.z)

rebar/src/main/resources/lang/en.yml

@@ -98,6 +98,9 @@ message:
     exposerecipe:
       not-configurable: "<red>This recipe type is not configurable"
       warning: "<yellow>Warning: exposing recipe configs will keep them from updating automatically. Delete %file% to revert"
+    finishmultiblock:
+      failed: "<red>You are not looking at a multiblock"
+      success: "Finished the multiblock"
 
   waila:
     type-disabled: "<red>This server no longer permits the your previously set %type% WAILA display type, it has been reset to default"