star/KSpigot
1
0
Fork 0
Code Pull Requests Packages Activity

Add deprecation warnings to the old chat component api

Browse Source
This commit is contained in:
Jakob K
2021-06-28 01:45:06 +02:00
parent 528d8abe3f
commit 2b77e6ab15
1 changed files with 60 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
src/main/kotlin/net/axay/kspigot/chat/KSpigotChat.kt
View File

@@ -1,4 +1,4 @@
@file:Suppress("MemberVisibilityCanBePrivate")
@file:Suppress("MemberVisibilityCanBePrivate", "DEPRECATION")
package net.axay.kspigot.chat
@@ -9,21 +9,48 @@ import net.md_5.bungee.api.chat.hover.content.Item
import net.md_5.bungee.api.chat.hover.content.Text
import java.awt.Color
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith("literalText { builder.invoke() }", "net.axay.kspigot.chat.literalText")
)
inline fun chatComponent(builder: KSpigotComponentBuilder.() -> Unit): Array<out BaseComponent> {
return KSpigotComponentBuilder().apply(builder).create()
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith("LiteralTextBuilder", "net.axay.kspigot.chat.LiteralTextBuilder")
)
class KSpigotComponentBuilder {
private val components = ArrayList<BaseComponent>()
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith("text(text, builder)", "net.axay.kspigot.chat.LiteralTextBuilder.text")
)
inline fun text(text: String, builder: TextComponent.() -> Unit = { }) {
this += TextComponent(text).apply(builder)
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith(
"text(KeybindComponent(keybind)) { builder.invoke() }",
"net.axay.kspigot.chat.LiteralTextBuilder.text", "net.md_5.bungee.api.chat.KeybindComponent"
)
)
inline fun keybind(keybind: String, builder: KeybindComponent.() -> Unit = { }) {
this += KeybindComponent(keybind).apply(builder)
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith(
"text(ScoreComponent(name, objective, value)) { builder.invoke() }",
"net.axay.kspigot.chat.LiteralTextBuilder.text", "net.md_5.bungee.api.chat.ScoreComponent"
)
)
inline fun score(name: String, objective: String, value: String?, builder: ScoreComponent.() -> Unit = { }) {
if (value != null)
this += ScoreComponent(name, objective, value).apply(builder)
@@ -31,10 +58,24 @@ class KSpigotComponentBuilder {
this += ScoreComponent(name, objective).apply(builder)
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith(
"text(SelectorComponent(selector)) { builder.invoke() }",
"net.axay.kspigot.chat.LiteralTextBuilder.text", "net.md_5.bungee.api.chat.SelectorComponent"
)
)
inline fun selector(selector: String, builder: SelectorComponent.() -> Unit = { }) {
this += SelectorComponent(selector).apply(builder)
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith(
"text(TranslatableComponent(translatable, with)) { builder.invoke() }",
"net.axay.kspigot.chat.LiteralTextBuilder.text", "net.md_5.bungee.api.chat.TranslatableComponent"
)
)
inline fun translatable(
translatable: String,
with: Array<BaseComponent>,
@@ -43,14 +84,32 @@ class KSpigotComponentBuilder {
this += TranslatableComponent(translatable, with).apply(builder)
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith("legacyText(text) { builder.invoke(); this.color = color }", "net.axay.kspigot.chat.LiteralTextBuilder.legacyText")
)
fun legacyText(text: String, color: ChatColor = ChatColor.WHITE, builder: BaseComponent.() -> Unit = { }) {
this += TextComponent.fromLegacyText(text, color).onEach { it.apply(builder) }
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith(
"text(baseComponent)",
"net.axay.kspigot.chat.LiteralTextBuilder.text", "net.md_5.bungee.api.chat.BaseComponent"
)
)
operator fun plusAssign(baseComponent: BaseComponent) {
components += baseComponent
}
@Deprecated(
"Outdated api, use literalText instead",
ReplaceWith(
"text(baseComponents)",
"net.axay.kspigot.chat.LiteralTextBuilder.text", "net.md_5.bungee.api.chat.BaseComponent"
)
)
operator fun plusAssign(baseComponents: Array<out BaseComponent>) {
components += baseComponents
}