api-common/su.plo.slib.api.chat.component/McTranslatableText

McTranslatableText

class McTranslatableText(val key: String, val args: Array<Any>) : McTextComponent

Represents a Minecraft translatable text component.

This class represents a text component that can be translated based on a localization key and optional arguments.

Parameters

key

The translation key used to look up the localized text.

args

An array of arguments to replace placeholders in the localized text.

Constructors

McTranslatableText

constructor(key: String, args: Array<Any>)

Properties

args

val args: Array<Any>

clickEvent

var clickEvent: McTextClickEvent?

The click event associated with this text component, if any.

hoverEvent

var hoverEvent: McTextHoverEvent?

The hover event associated with this text component, if any.

key

val key: String

siblings

val siblings: MutableList<McTextComponent>

List of sibling text components that are displayed alongside this component.

styles

val styles: MutableList<McTextStyle>

List of text styles applied to this component.

Functions

append

fun append(vararg components: McTextComponent): McTextComponent

Appends one or more text components to the list of siblings.

fun append(components: Collection<McTextComponent>): McTextComponent

Appends a collection of text components to the list of siblings.

clickEvent

fun clickEvent(clickEvent: McTextClickEvent?): McTextComponent

Sets the click event for this text component.

hoverEvent

fun hoverEvent(hoverEvent: McTextHoverEvent?): McTextComponent

Sets the hover event for this text component.

mergeWith

fun mergeWith(component: McTextComponent): McTextComponent

Merges this text component with another text component, combining their styles, siblings, and events.

toString

open override fun toString(): String

withStyle

fun withStyle(vararg styles: McTextStyle): McTextComponent

Applies one or more styles to this text component.

fun withStyle(style: McTextStyle): McTextComponent

Applies a style to this text component.