update hover event

Author: p1k0chu

src/main/kotlin/io/github/dockyardmc/scroll/ClickEvent.kt

@@ -151,7 +151,4 @@ sealed class ClickEvent {
             }
         }
     }
-}
-
-class MissingFieldException(field: String) :
-    RuntimeException("failed to parse: field `$field` is missing")
+}

src/main/kotlin/io/github/dockyardmc/scroll/HoverAction.kt

@@ -1,9 +1,94 @@
 package io.github.dockyardmc.scroll
 
+import io.github.dockyardmc.scroll.extensions.put
+import io.github.dockyardmc.scroll.extensions.toComponent
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
+import kotlinx.serialization.Transient
+import kotlinx.serialization.json.JsonClassDiscriminator
+import org.jglrxavpok.hephaistos.nbt.NBT
+import org.jglrxavpok.hephaistos.nbt.NBTCompound
 
+@Suppress("MemberVisibilityCanBePrivate")
+@OptIn(ExperimentalSerializationApi::class)
 @Serializable
-class HoverEvent(
-    val action: HoverAction,
-    val contents: Component? = null
-)
+@JsonClassDiscriminator("action")
+sealed class HoverEvent {
+    abstract val type: String
+
+    open fun getNbt(): NBTCompound {
+        return NBT.Compound { builder ->
+            builder.put("action", type)
+        }
+    }
+
+    companion object {
+        /**
+         * @throws MissingFieldException if there's a field missing
+         * @throws UnsupportedOperationException if `action` is not supported
+         */
+        fun fromNbt(nbt: NBTCompound): HoverEvent {
+            return when (val action = nbt.getString("action")) {
+                "show_text" -> ShowText(nbt.getCompound("value")?.toComponent() ?: throw MissingFieldException("value"))
+                "show_item" -> ShowItem(
+                    nbt.getString("id") ?: throw MissingFieldException("id"),
+                    nbt.getInt("count") ?: throw MissingFieldException("count")
+                )
+                "show_entity" -> ShowEntity(
+                    nbt.getString("id") ?: throw MissingFieldException("id"),
+                    nbt.getString("uuid") ?: throw MissingFieldException("uuid"),
+                    nbt.getCompound("name")?.toComponent() ?: throw MissingFieldException("name")
+                )
+
+                null -> throw MissingFieldException("action")
+                else -> throw UnsupportedOperationException("unknown `action`: `$action`")
+            }
+        }
+    }
+
+    @Serializable
+    @SerialName("show_text")
+    class ShowText(val value: Component) : HoverEvent() {
+        constructor(value: String) : this(value.toComponent())
+
+        @Transient
+        override val type: String = "show_text"
+
+        override fun getNbt(): NBTCompound {
+            return super.getNbt().kmodify {
+                put("value", value.toNBT())
+            }
+        }
+    }
+
+    // TODO: add components (recursive dependency? :( )
+    @Serializable
+    @SerialName("show_item")
+    class ShowItem(val id: String, val count: Int) : HoverEvent() {
+        @Transient
+        override val type: String = "show_item"
+
+        override fun getNbt(): NBTCompound {
+            return super.getNbt().kmodify {
+                put("id", id)
+                put("count", count)
+            }
+        }
+    }
+
+    @SerialName("show_entity")
+    class ShowEntity(val id: String, val uuid: String, val name: Component? = null) : HoverEvent() {
+        @Transient
+        override val type: String = "show_entity"
+
+        override fun getNbt(): NBTCompound {
+            return super.getNbt().kmodify {
+                put("id", id)
+                put("uuid", uuid)
+                if(name != null)
+                    put("name", name.toNBT())
+            }
+        }
+    }
+}

src/main/kotlin/io/github/dockyardmc/scroll/HoverEvent.kt

@@ -0,0 +1,4 @@
+package io.github.dockyardmc.scroll
+
+class MissingFieldException(field: String) :
+    RuntimeException("failed to parse: field `$field` is missing")

src/main/kotlin/io/github/dockyardmc/scroll/MissingFieldException.kt

@@ -1,23 +1,24 @@
 package io.github.dockyardmc.scroll.providers.default
 
 import io.github.dockyardmc.scroll.Component
-import io.github.dockyardmc.scroll.HoverAction
 import io.github.dockyardmc.scroll.HoverEvent
-import io.github.dockyardmc.scroll.Scroll
+import io.github.dockyardmc.scroll.extensions.toComponent
 import io.github.dockyardmc.scroll.providers.ClosingNamedFormatProvider
 import io.github.dockyardmc.scroll.providers.FormatProviderContext
 
 class HoverEventProvider: ClosingNamedFormatProvider("hover", listOf()) {
 
     override fun formatNormal(context: FormatProviderContext, component: Component) {
-        val action = HoverAction.valueOf(context.getArgument(0).uppercase())
-        val value = Scroll.parse(context.getArgument(1))
-        val hoverEvent = HoverEvent(action, value)
+        component.hoverEvent = when (context.getArgument(0)) {
+            "show_text" -> HoverEvent.ShowText(context.getArgument(1).toComponent())
+            "show_item" -> HoverEvent.ShowItem(context.getArgument(1), context.getArgumentOrNull(2)?.toIntOrNull() ?: 1)
+            "show_entity" -> HoverEvent.ShowEntity(context.getArgument(1), context.getArgument(2), context.getArgumentOrNull(3)?.toComponent())
 
-        component.hoverEvent = hoverEvent
+            else -> return
+        }
     }
 
     override fun formatClosing(context: FormatProviderContext, component: Component) {
         component.hoverEvent = null
     }
-}
+}

src/main/kotlin/io/github/dockyardmc/scroll/providers/default/HoverEventProvider.kt

@@ -31,10 +31,7 @@ object ComponentToNbtSerializer {
 
         val hover = c.hoverEvent
         if(hover != null) {
-            nbtWriter.put("hover_event", NBT.Compound { hoverWriter ->
-                hoverWriter.put("action", hover.action.name.lowercase())
-                hoverWriter.put("contents", serializeComponent(hover.contents!!))
-            })
+            nbtWriter.put("hover_event", hover.getNbt())
         }
 
         val click = c.clickEvent

src/main/kotlin/io/github/dockyardmc/scroll/serializers/ComponentToNbtSerializer.kt

@@ -49,9 +49,10 @@ object KyoriToScrollSerializer {
     }
 
     private fun net.kyori.adventure.text.event.HoverEvent<*>.toScroll(): HoverEvent? {
-        val value = this.value()
-        return when(this.value()) {
-            is net.kyori.adventure.text.Component -> HoverEvent(HoverAction.SHOW_TEXT, serializeComponent(value as net.kyori.adventure.text.Component))
+        return when(val value = this.value()) {
+            is net.kyori.adventure.text.Component -> HoverEvent.ShowText(value.toScroll())
+            is net.kyori.adventure.text.event.HoverEvent.ShowItem -> HoverEvent.ShowItem(value.item().asString(), value.count())
+            is net.kyori.adventure.text.event.HoverEvent.ShowEntity -> HoverEvent.ShowEntity(value.type().asString(), value.id().toString(), value.name()?.toScroll())
             else -> null
         }
     }

src/main/kotlin/io/github/dockyardmc/scroll/serializers/KyoriToScrollSerializer.kt

@@ -27,10 +27,7 @@ object NbtToComponentSerializer {
 
         val hover = nbt.getCompound("hover_event")
         if (hover != null) {
-            val action = hover.getString("action")!!
-            val content = hover.getCompound("contents")!!
-
-            component.hoverEvent = HoverEvent(HoverAction.valueOf(action.uppercase()), serializeNbt(content))
+            component.hoverEvent = HoverEvent.fromNbt(hover)
         }
 
         val click = nbt.getCompound("click_event")

src/main/kotlin/io/github/dockyardmc/scroll/serializers/NbtToComponentSerializer.kt

@@ -15,7 +15,7 @@ class NbtSerializationTests {
         val nbt = NBT.Compound {
             it.put("hover_event", NBT.Compound { hover ->
                 hover.put("action", "show_text")
-                hover.put("contents", NBT.Compound { hoverIn ->
+                hover.put("value", NBT.Compound { hoverIn ->
                     hoverIn.put("extra", NBT.Compound {
                         it.put("extra", NBT.Compound { extrahover ->
                             extrahover.put("text", "Click to open the store URL")

src/test/kotlin/NbtSerializationTests.kt

@@ -141,7 +141,7 @@ class StringSerializationTests {
     fun testHover() {
         val input = "<hover:show_text:'<red><bold><i>bucket o' fish'>hover over meeeee <r>do not hover over me"
         val expected = Component.compound(mutableListOf(
-            Component(text = "hover over meeeee ", hoverEvent = HoverEvent(HoverAction.SHOW_TEXT, "<red><bold><i>bucket o' fish".toComponent())),
+            Component(text = "hover over meeeee ", hoverEvent = HoverEvent.ShowText("<red><bold><i>bucket o' fish".toComponent())),
             Component(text = "do not hover over me")
         ))