nova/xyz.xenondevs.nova.util.component.adventure

Package-level declarations

Types

PlainTextComponentConverter

object PlainTextComponentConverter

StyledElement

sealed interface StyledElement

Represents a renderable element of a Component with an associated Style.

Functions

append

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.append(fontChar: FontChar): B

Appends the fontChar's component to this component.

appendCentered

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.appendCentered(component: Component, lang: String = "en_us"): B

Moves the cursor by half the width of the component to the left, then appends the component.

color

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.color(color: Color): B

Sets the color of this component to color.

elements

fun Component.elements(lang: String = "en_us"): Sequence<StyledElement>

Flattens this Component into a sequence of StyledElements using the specified lang for translations.

fun Component.elements(translate: (key: String) -> String?, outerStyle: Style = Style.empty()): Sequence<StyledElement>

Flattens this Component into a sequence of StyledElements using the specified translate function for translations. An optional outerStyle can be provided to be merged with each element's style.

font

fun Component.font(font: String): Component

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.font(font: String): B

Sets the font of this component to font.

fontName

fun Component.fontName(): String?

move

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.move(distance: Number): B

Moves the cursor by distance gui-scale-affected pixels.

moveTo

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.moveTo(afterStart: Number, lang: String = "en_us"): B

Moves the cursor to afterStart pixels after the beginning of the text, using lang to localize all potential translatable components.

moveToCenter

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.moveToCenter(lang: String = "en_us"): B

Moves the cursor to the center of the text, using lang to localize all potential translatable components.

moveToStart

fun <C : BuildableComponent<C, B>, B : ComponentBuilder<C, B>> ComponentBuilder<C, B>.moveToStart(lang: String = "en_us"): B

Moves the cursor to the beginning of the text, using lang to localize all potential translatable components.

toAdventureComponent

fun Array<out BaseComponent>.toAdventureComponent(): Component

fun String.toAdventureComponent(): Component

fun Component.toAdventureComponent(): Component

toAdventureComponentOr

fun String.toAdventureComponentOr(createComponent: () -> Component): Component

toAdventureComponentOrEmpty

fun String.toAdventureComponentOrEmpty(): Component

toAdventureComponentOrNull

fun String.toAdventureComponentOrNull(): Component?

toJson

fun Component.toJson(): String

toNBT

fun Component.toNBT(): StringTag

toNMSComponent

fun Component.toNMSComponent(): Component

toNmsStyle

fun Style.toNmsStyle(): Style

toPlainText

fun Component.toPlainText(locale: String = "en_us"): String

fun Component.toPlainText(player: Player): String

withoutPreFormatting

fun Component.withoutPreFormatting(): Component