kraftlin-message-core/io.github.kraftlin.message

Package-level declarations

io.github.kraftlin.message.message: Entry point for building components.
io.github.kraftlin.message.ClickableMessage: DSL scope for multi-component messages.
io.github.kraftlin.message.ClickableText: DSL scope for styling individual text components.

Types

ChatMarker

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ChatMarker

Marks Kraftlin message DSL scopes to prevent accidental nesting.

Clickable

interface Clickable

A part of a message which supports mouse interaction.

ClickableMessage

class ClickableMessage : Stylable, Clickable

A chat message the user can interact with.

ClickableText

class ClickableText(builder: ComponentBuilder<*, *>) : Text, Stylable, Clickable

A text part of a ClickableMessage.

Message

class Message : Stylable

A basic formatted Chat Message.

Stylable

interface Stylable

A part of a message to which text formatting can be applied.

Text

open class Text(builder: ComponentBuilder<*, *>) : Stylable

A text part of a Message.

Functions

fromLegacyMessage

fun fromLegacyMessage(legacy: String): TextComponent

Deserializes a legacy '§'-formatted legacy string into a TextComponent.

message

fun message(init: ClickableMessage.() -> Unit): Component

Builds a new chat message.

fun message(text: String, init: ClickableText.() -> Unit = {}): Component

fun message(component: Component, init: ClickableText.() -> Unit = {}): Component

Convenience method to build a simple single component message. For more flexible messages, use the overloaded version.

fun message(text: String, color: TextColor): Component

Convenience method to build a simple colorized message. For more flexible messages, use the overloaded version.

message

fun Audience.message(block: ClickableMessage.() -> Unit)

Builds and sends a chat message to this Audience.

fun Audience.message(text: String, block: ClickableText.() -> Unit)

Builds and sends a styled text message to this Audience.

fun Audience.message(text: String, color: TextColor? = null)

Builds and sends a simple text message to this Audience.

fun Audience.message(component: Component, block: ClickableText.() -> Unit = {})

Builds and sends a component-based message to this Audience.

toLegacyMessage

fun Component.toLegacyMessage(): String

Converts a complex message to a single string with formatting characters as used in old Minecraft versions.