vital-utils/dev.vitalframework.utils/VitalUtils/Companion

Companion

Defines utilities for general purposes across multiple platforms.

Functions

fun buildBlacklistedWordRegex(word: String): Regex

Builds a Regex with the given String, that matches the given String in multiple permutations, that may be possible when wanting to block specific words. BLocked permutations include:

chatButton

@JvmStatic

fun chatButton(hover: String, text: String, click: String, action: ClickEvent.Action): String

Creates a chat button String in MiniMessage formatting. Can be used to create interactable text in chat.

chatRunCommandAcceptButton

@JvmStatic

fun chatRunCommandAcceptButton(command: String): String

Creates a chat button String in MiniMessage formatting, with the text "ACCEPT" in bold green, that when clicked, executes the given command.

chatRunCommandButton

@JvmStatic

fun chatRunCommandButton(text: String, command: String): String

Creates a chat button String in MiniMessage formatting, that when clicked, executes the given command.

chatRunCommandCheckmarkButton

@JvmStatic

fun chatRunCommandCheckmarkButton(command: String): String

Creates a chat button String in MiniMessage formatting, with a checkmark, that when clicked, executed the given command.

chatRunCommandDeclineButton

@JvmStatic

fun chatRunCommandDeclineButton(command: String): String

Creates a chat button String in MiniMessage formatting, with the text "DECLINE" in bold red, that when clicked, executes the given command.

chatRunCommandNoButton

@JvmStatic

fun chatRunCommandNoButton(command: String): String

Creates a chat button String in MiniMessage formatting, with the text "NO" in bold red, that when clicked, executes the given command.

chatRunCommandOkButton

@JvmStatic

fun chatRunCommandOkButton(command: String): String

Creates a chat button String in MiniMessage formatting, with the text "OK" in bold green, that when clicked, executes the given command.

chatRunCommandXButton

@JvmStatic

fun chatRunCommandXButton(command: String): String

Creates a chat button String in MiniMessage formatting, with the text "x" in bold red, that when clicked, executes the given command.

chatRunCommandYesButton

@JvmStatic

fun chatRunCommandYesButton(command: String): String

Creates a chat button String in MiniMessage formatting, with the text "YES" in bold green, that when clicked, executes the given command.

chatSuggestCommandButton

@JvmStatic

fun chatSuggestCommandButton(text: String, command: String): String

Creates a chat button String in MiniMessage formatting, that when clicked, inserts the given command into the player's chat.

getCensoredText

@JvmStatic

fun getCensoredText(text: String, blacklistedWords: List<String>): String

Converts the given String into its censored version, where each blacklisted word in blacklistedWords is replaced by its censored version. E. G. "fuck" -> "f***".

toBlacklistedWordRegex

@JvmStatic

fun String.toBlacklistedWordRegex(): Regex

Converts the given String into a Regex, that matches the given String in multiple permutations, that may be possible when wanting to block specific words. Blocked permutations include:

toBungeeComponent

@JvmStatic

fun Component.toBungeeComponent(): @NotNull Array<out @NotNull BaseComponent>

Converts the given Component into an Array of BaseComponent, usable on BungeeCord systems.

toCensoredText

@JvmStatic

fun String.toCensoredText(blacklistedWords: List<String>): String

Converts the given String into its censored version, where each blacklisted word in blacklistedWords is replaced by its censored version. E. G. "fuck" -> "f***".

toLegacyAmpersandString

@JvmStatic

fun Component.toLegacyAmpersandString(): @NotNull String

Converts the given Component into a String with legacy ampersand (&) formatting.

toLegacySectionString

@JvmStatic

fun Component.toLegacySectionString(): @NotNull String

Converts the given Component into a String with legacy section (§) formatting.

toMiniMessageComponent

@JvmStatic

fun String.toMiniMessageComponent(): @NotNull Component

Converts the given String into a Component using MiniMessage.deserialize.