Merge pull request #153 from pylonmc/allow-disabling-items

Allow disabling items & change research disabling logic

Author: LordIdra

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

@@ -7,6 +7,7 @@ import io.github.pylonmc.pylon.core.block.context.BlockBreakContext
 import io.github.pylonmc.pylon.core.block.context.BlockCreateContext
 import io.github.pylonmc.pylon.core.event.PylonBlockUnloadEvent
 import io.github.pylonmc.pylon.core.item.PylonItem
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.canUse
 import io.github.pylonmc.pylon.core.util.position.position
 import io.papermc.paper.event.block.*
 import io.papermc.paper.event.entity.EntityCompostItemEvent
@@ -16,6 +17,7 @@ import io.papermc.paper.event.player.PlayerLecternPageChangeEvent
 import io.papermc.paper.event.player.PlayerOpenSignEvent
 import org.bukkit.GameMode
 import org.bukkit.Material
+import org.bukkit.block.BlockFace
 import org.bukkit.event.EventHandler
 import org.bukkit.event.EventPriority
 import org.bukkit.event.Listener
@@ -48,10 +50,17 @@ internal object BlockListener : Listener {
         val item = event.itemInHand
         val player = event.player
 
-        val pylonItem = PylonItem.fromStack(item)
-        val pylonBlock = pylonItem?.place(BlockCreateContext.PlayerPlace(player, item, event))
+        val pylonItem = PylonItem.fromStack(item) ?: return
+        if (!event.player.canUse(pylonItem, true)) {
+            event.isCancelled = true
+            return
+        }
+        val relative = event.blockPlaced.position - event.blockAgainst.position
+        val blockFace = BlockFace.entries.find { it.modX == relative.x && it.modY == relative.y && it.modZ == relative.z }
+            ?: BlockFace.SELF
+        val pylonBlock = pylonItem.place(BlockCreateContext.PlayerPlace(player, item, event))
 
-        if (pylonItem != null && pylonBlock == null) {
+        if (pylonBlock == null) {
             event.isCancelled = true
         }
 

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/command/PylonCommand.kt

@@ -10,6 +10,7 @@ import io.github.pylonmc.pylon.core.block.waila.Waila.Companion.wailaEnabled
 import io.github.pylonmc.pylon.core.debug.DebugWaxedWeatheredCutCopperStairs
 import io.github.pylonmc.pylon.core.guide.PylonGuide
 import io.github.pylonmc.pylon.core.i18n.PylonArgument
+import io.github.pylonmc.pylon.core.item.PylonItem
 import io.github.pylonmc.pylon.core.item.research.Research
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchPoints
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researches
@@ -28,6 +29,7 @@ import org.bukkit.Material
 import org.bukkit.NamespacedKey
 import org.bukkit.command.CommandSender
 import org.bukkit.entity.Player
+import org.bukkit.inventory.EquipmentSlot
 import org.bukkit.permissions.Permission
 import org.bukkit.permissions.PermissionDefault
 import org.jetbrains.annotations.ApiStatus
@@ -83,6 +85,18 @@ internal class PylonCommand : BaseCommand() {
         player.give(DebugWaxedWeatheredCutCopperStairs.STACK)
     }
 
+    @Subcommand("key")
+    @Description("Shows you the key of the item in your main hand")
+    @CommandPermission("pylon.command.key")
+    fun key(player: Player) {
+        val item = PylonItem.fromStack(player.inventory.getItem(EquipmentSlot.HAND))
+        if (item == null) {
+            player.sendRichMessage("<red>You are not holding a Pylon item")
+            return
+        }
+        player.sendRichMessage(item.key.toString())
+    }
+
     @Subcommand("setblock")
     @CommandCompletion("@blocks")
     @Description("Set a block to be a pylon block")

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/config/PylonConfig.kt

@@ -1,6 +1,7 @@
 package io.github.pylonmc.pylon.core.config
 
 import io.github.pylonmc.pylon.core.PylonCore
+import org.bukkit.NamespacedKey
 
 object PylonConfig {
 
@@ -32,4 +33,16 @@ object PylonConfig {
 
     @JvmStatic
     val translationWrapLimit: Int by config
+
+    @JvmStatic
+    val disabledItems: Set<NamespacedKey> =
+        config.getOrThrow<List<String>>("disabled-items")
+            .mapNotNull {
+                val key = NamespacedKey.fromString(it)
+                if (key == null) {
+                    PylonCore.logger.warning { "Invalid disabled-items key '$it'" }
+                }
+                key
+            }
+            .toSet()
 }

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/event/PrePylonCraftEvent.kt

@@ -0,0 +1,36 @@
+package io.github.pylonmc.pylon.core.event
+
+import io.github.pylonmc.pylon.core.block.PylonBlock
+import io.github.pylonmc.pylon.core.recipe.PylonRecipe
+import io.github.pylonmc.pylon.core.recipe.RecipeType
+import org.bukkit.entity.Player
+import org.bukkit.event.Cancellable
+import org.bukkit.event.Event
+import org.bukkit.event.HandlerList
+
+/**
+ * Called when a crafting recipe is started
+ */
+class PrePylonCraftEvent<T: PylonRecipe> @JvmOverloads constructor(
+    val type: RecipeType<T>,
+    val recipe: T,
+    val block: PylonBlock? = null,
+    val player: Player? = null
+) : Event(), Cancellable {
+
+    private var isCancelled = false
+
+    override fun isCancelled(): Boolean = isCancelled
+
+    override fun setCancelled(cancel: Boolean) {
+        isCancelled = cancel
+    }
+
+    override fun getHandlers(): HandlerList
+        = handlerList
+
+    companion object {
+        @JvmStatic
+        val handlerList: HandlerList = HandlerList()
+    }
+}

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/event/PylonCraftEvent.kt

@@ -0,0 +1,25 @@
+package io.github.pylonmc.pylon.core.event
+
+import io.github.pylonmc.pylon.core.block.PylonBlock
+import io.github.pylonmc.pylon.core.recipe.PylonRecipe
+import io.github.pylonmc.pylon.core.recipe.RecipeType
+import org.bukkit.event.Event
+import org.bukkit.event.HandlerList
+
+/**
+ * Called when a crafting recipe is started
+ */
+class PylonCraftEvent<T: PylonRecipe> @JvmOverloads constructor(
+    val type: RecipeType<T>,
+    val recipe: T,
+    val block: PylonBlock? = null,
+) : Event() {
+
+    override fun getHandlers(): HandlerList
+        = handlerList
+
+    companion object {
+        @JvmStatic
+        val handlerList: HandlerList = HandlerList()
+    }
+}

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/guide/button/ItemButton.kt

@@ -8,15 +8,14 @@ import io.github.pylonmc.pylon.core.i18n.PylonArgument
 import io.github.pylonmc.pylon.core.item.PylonItem
 import io.github.pylonmc.pylon.core.item.builder.ItemStackBuilder
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.canUse
+import io.github.pylonmc.pylon.core.item.research.Research.Companion.canCraft
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.research
 import io.github.pylonmc.pylon.core.item.research.Research.Companion.researchPoints
-import io.github.pylonmc.pylon.core.item.research.Research.Companion.researches
 import io.github.pylonmc.pylon.core.registry.PylonRegistry
 import io.papermc.paper.datacomponent.DataComponentTypes
 import io.papermc.paper.datacomponent.item.ItemLore
 import net.kyori.adventure.text.Component
 import net.kyori.adventure.text.TranslatableComponent
-import org.bukkit.Bukkit
 import org.bukkit.Material
 import org.bukkit.NamespacedKey
 import org.bukkit.entity.Player
@@ -57,7 +56,11 @@ class ItemButton(val stack: ItemStack) : AbstractItem() {
             builder.name(stackName.arguments(placeholders))
         }
 
-        if (!player.canUse(item)) {
+        if (item.isDisabled) {
+            builder.set(DataComponentTypes.ITEM_MODEL, Material.STRUCTURE_VOID.key)
+        }
+
+        if (!player.canCraft(item)) {
             builder.set(DataComponentTypes.ITEM_MODEL, Material.BARRIER.key)
                 .set(DataComponentTypes.ENCHANTMENT_GLINT_OVERRIDE, false)
                 .lore(Component.translatable("pylon.pyloncore.guide.button.item.not-researched"))

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/i18n/PlayerTranslationHandler.kt

@@ -25,7 +25,12 @@ class PlayerTranslationHandler(val player: Player) {
             GlobalTranslator.render(attacher.render(it, Unit), player.locale())
         }
         item.stack.editData(DataComponentTypes.LORE) { lore ->
-            val newLore: MutableList<Component> = (lore.lines() + item.addon.displayName).flatMapTo(mutableListOf()) { line ->
+            val toTranslate = (lore.lines() + item.addon.displayName).toMutableList()
+            if (item.isDisabled) {
+                toTranslate.add(Component.translatable("pylon.pyloncore.message.disabled.lore"))
+            }
+
+            val newLore: MutableList<Component> = toTranslate.flatMapTo(mutableListOf()) { line ->
                 val translated = GlobalTranslator.render(attacher.render(line, Unit), player.locale())
                 val encoded = LineWrapEncoder.encode(translated)
                 val wrapped = encoded.copy(lines = encoded.lines.flatMap(wrapper::wrap))

pylon-core/src/main/kotlin/io/github/pylonmc/pylon/core/item/PylonItem.kt

@@ -4,6 +4,7 @@ import io.github.pylonmc.pylon.core.PylonCore
 import io.github.pylonmc.pylon.core.block.PylonBlock
 import io.github.pylonmc.pylon.core.block.context.BlockCreateContext
 import io.github.pylonmc.pylon.core.config.Config
+import io.github.pylonmc.pylon.core.config.PylonConfig
 import io.github.pylonmc.pylon.core.config.Settings
 import io.github.pylonmc.pylon.core.datatypes.PylonSerializers
 import io.github.pylonmc.pylon.core.i18n.AddonTranslator
@@ -24,6 +25,7 @@ open class PylonItem(val stack: ItemStack) : Keyed {
     val researchBypassPermission = schema.researchBypassPermission
     val addon = schema.addon
     val pylonBlock = schema.pylonBlockKey
+    val isDisabled: Boolean = PylonConfig.disabledItems.contains(key)
 
     fun getSettings() = Settings.get(key)