FloppaClient/floppaclient.utils/ChatUtils

ChatUtils

object ChatUtils

A collection of utility functions for creating and sending or displaying chat messages.

Use chatMessage to put messages in chat which are only visible locally and are not sent to the server.

Use modMessage for client side messages in chat that start with mods chat prefix.

Use sendChat for sending a player message to the server.

Use command to execute commands either client side or send them to the server.

Author

Aton

Functions

chatMessage

fun chatMessage(iChatComponent: IChatComponent)

fun chatMessage(text: String, reformat: Boolean = true)

Print a message in chat client side.

command

fun command(text: String, clientSide: Boolean = true)

Runs the specified command. Per default sends it to the server but has client side option. The input is assumed to not include the slash "/" that signals a command.

createHoverableText

fun createHoverableText(text: String, hoverText: String): IChatComponent

Creates a new IChatComponent displaying text and showing hoverText when it is hovered. hoverText can include "\n" for new lines.

modMessage

fun modMessage(iChatComponent: IChatComponent)

fun modMessage(text: String, reformat: Boolean = true)

Puts a message in chat client side with the mod prefix.

sendChat

fun sendChat(message: String)

Send player message to the server.

stripControlCodes

fun String.stripControlCodes(): String

Remove control codes from the receiver with the vanilla function for it.

Properties

val AQUA: String

val BLACK: String

val BLUE: String

val BOLD: String

val DARK_AQUA: String

DARK_BLUE

val DARK_BLUE: String

DARK_GRAY

val DARK_GRAY: String

DARK_GREEN

val DARK_GREEN: String

DARK_PURPLE

val DARK_PURPLE: String

val DARK_RED: String

val GOLD: String

val GRAY: String

val GREEN: String

val ITALIC: String

val LIGHT_PURPLE: String

OBFUSCATED

val OBFUSCATED: String

RED

val RED: String

RESET

val RESET: String

STRIKETHROUGH

val STRIKETHROUGH: String

UNDERLINE

val UNDERLINE: String

WHITE

val WHITE: String

YELLOW

val YELLOW: String