ChatTriggers/com.chattriggers.ctjs.minecraft.objects.message/TextComponent

TextComponent

class TextComponent

Constructors

TextComponent

fun TextComponent(text: String)

Creates a TextComponent from a string.

TextComponent

fun TextComponent(chatComponent: MCITextComponent)

Creates a TextComponent from an existing ITextComponent.

Types

Companion

object Companion

Functions

actionBar

fun actionBar()

Shows the component on the actionbar as a new Message

chat

fun chat()

Shows the component in chat as a new Message

getClickAction

fun getClickAction(): String?

getClickValue

fun getClickValue(): String?

getHoverAction

fun getHoverAction(): String?

getHoverValue

fun getHoverValue(): String?

getText

fun getText(): String

isFormatted

fun isFormatted(): Boolean

setClick

fun setClick(action: String, value: String): TextComponent

Sets the click action and value of the component. See TextComponent.setClickAction for possible click actions.

setClickAction

fun setClickAction(action: String): TextComponent

Sets the action to be performed when the component is clicked on. Possible actions include:

setClickValue

fun setClickValue(value: String): TextComponent

Sets the value to be used by the click action. See TextComponent.setClickAction for possible click actions.

setFormatted

fun setFormatted(formatted: Boolean): TextComponent

Sets if the component is to be formatted

setHover

fun setHover(action: String, value: String): TextComponent

Sets the hover action and value of the component. See TextComponent.setHoverAction for possible hover actions.

setHoverAction

fun setHoverAction(action: String): TextComponent

Sets the action to be performed when the component is hovered over. Hover action is set to 'show_text' by default. Possible actions include:

setHoverValue

fun setHoverValue(value: String): TextComponent

Sets the value to be used by the hover action. See TextComponent.setHoverAction for possible hover actions.

setText

fun setText(text: String): TextComponent

Sets the components text string.

toString

open override fun toString(): String

Properties

chatComponentText

lateinit var chatComponentText: MCITextComponent

Sources

jvm source