api(component): 内部仕様を改善。関数を追加 #52

Author: sya-ri

api/build.gradle.kts

@@ -11,7 +11,7 @@ repositories {
 }
 
 group = "com.github.sya-ri.spigot.api"
-version = "2.2.1"
+version = "2.2.2"
 
 bukkit {
     name = "EasySpigotAPI"

api/src/main/kotlin/com/github/syari/spigot/api/component/TextComponentBuilder.kt

@@ -1,6 +1,5 @@
 package com.github.syari.spigot.api.component
 
-import com.github.syari.spigot.api.string.toColor
 import net.md_5.bungee.api.chat.ClickEvent
 import net.md_5.bungee.api.chat.HoverEvent
 import net.md_5.bungee.api.chat.TextComponent
@@ -10,7 +9,7 @@ import net.md_5.bungee.api.chat.TextComponent
  * @since 1.6.0
  */
 class TextComponentBuilder {
-    private val components = mutableListOf<Component>()
+    private val components = mutableListOf<TextComponent>()
 
     /**
      * 末尾に文字列を挿入する。
@@ -23,17 +22,22 @@ class TextComponentBuilder {
         text: String,
         hover: HoverEvent? = null,
         click: ClickEvent? = null
-    ) = apply {
-        components.add(Component(text, hover, click))
+    ) = append(textComponent(text, hover, click))
+
+    /**
+     * 末尾に [TextComponent] を挿入する。
+     * @param component
+     * @since 2.2.2
+     */
+    fun append(component: TextComponent) = apply {
+        components.add(component)
     }
 
     /**
      * 末尾に改行を挿入する。
      * @since 1.6.0
      */
-    fun appendLine() = apply {
-        components.add(Component.NewLine)
-    }
+    fun appendLine() = append(NewLine)
 
     /**
      * 末尾に文字列を挿入し、改行する。
@@ -48,22 +52,22 @@ class TextComponentBuilder {
         click: ClickEvent? = null
     ) = append(text, hover, click).appendLine()
 
+    /**
+     * 末尾に [TextComponent] を挿入し、改行する。
+     * @param component
+     * @since 2.2.2
+     */
+    fun appendLine(component: TextComponent) = append(component).appendLine()
+
     /**
      * [TextComponent] に変換する。
      * @since 1.6.0
      */
     fun build() = TextComponent().apply {
-        components.forEach {
-            TextComponent(it.text.toColor()).apply {
-                hoverEvent = it.hover
-                clickEvent = it.click
-            }.let(::addExtra)
-        }
+        components.forEach(::addExtra)
     }
 
-    private class Component(val text: String, val hover: HoverEvent?, val click: ClickEvent?) {
-        companion object {
-            val NewLine = Component("\n", null, null)
-        }
+    companion object {
+        val NewLine = TextComponent(System.lineSeparator())
     }
 }

api/src/main/kotlin/com/github/syari/spigot/api/component/extension.kt

@@ -6,6 +6,7 @@ import com.github.syari.spigot.api.string.toColor
 import net.md_5.bungee.api.chat.ClickEvent
 import net.md_5.bungee.api.chat.HoverEvent
 import net.md_5.bungee.api.chat.ItemTag
+import net.md_5.bungee.api.chat.TextComponent
 import net.md_5.bungee.api.chat.hover.content.Item
 import net.md_5.bungee.api.chat.hover.content.Text
 import org.bukkit.inventory.ItemStack
@@ -16,6 +17,21 @@ import org.bukkit.inventory.ItemStack
  */
 inline fun buildTextComponent(action: TextComponentBuilder.() -> Unit) = TextComponentBuilder().apply(action).build()
 
+/**
+ * @param text 文字列
+ * @param hover [HoverEvent] default: null
+ * @param click [ClickEvent] default: null
+ * @since 2.2.2
+ */
+fun textComponent(
+    text: String,
+    hover: HoverEvent? = null,
+    click: ClickEvent? = null,
+) = TextComponent(text.toColor()).apply {
+    hoverEvent = hover
+    clickEvent = click
+}
+
 /**
  * [ClickEvent.Action.RUN_COMMAND] の [ClickEvent]
  * @since 1.6.0

sample/README.md

@@ -77,6 +77,18 @@ class TextComponentBuilder {
  */
 inline fun buildTextComponent(action: TextComponentBuilder.() -> Unit): TextComponent
 
+
+/**
+ * @param text 文字列
+ * @param hover [HoverEvent] default: null
+ * @param click [ClickEvent] default: null
+ */
+fun textComponent(
+    text: String,
+    hover: HoverEvent? = null,
+    click: ClickEvent? = null,
+): TextComponent
+
 /**
  * [ClickEvent.Action.RUN_COMMAND] の [ClickEvent]
  */