vital-utils/dev.vitalframework.utils/VitalUtils

VitalUtils

interface VitalUtils<CS, P : CS>

Inheritors

Spigot

Bungee

Types

Bungee

object Bungee : VitalUtils<BungeeCommandSender, BungeePlayer>

Object representing essential utility functions for managing BungeeCord players and commands.

Companion

object Companion

Defines utilities for general purposes across multiple platforms.

Spigot

object Spigot : VitalUtils<SpigotCommandSender, SpigotPlayer>

Utility object providing Spigot-specific implementations of the VitalUtils abstraction.

Functions

broadcastAction

abstract fun broadcastAction(predicate: Predicate = Predicate { true }, action: Consumer)

Broadcasts an action to a collection of players based on a specified condition.

broadcastFormattedActionBar

open fun broadcastFormattedActionBar(message: String, predicate: Predicate = Predicate { true })

Broadcasts a formatted action bar message to all players satisfying the given predicate.

broadcastFormattedMessage

open fun broadcastFormattedMessage(message: String, predicate: Predicate = Predicate { true })

Broadcasts a formatted message to all players satisfying the given predicate.

broadcastFormattedPersistentTitle

open fun broadcastFormattedPersistentTitle(title: String = "", subtitle: String = "", fadeIn: @Range(from = 0, to = 72000) Int, predicate: Predicate = Predicate { true })

Sends a persistent formatted title and subtitle to all players that satisfy the specified predicate. The title remains displayed with the specified fade-in duration.

broadcastFormattedTitle

open fun broadcastFormattedTitle(title: String = "", subtitle: String = "", predicate: Predicate)

Broadcasts a formatted title and subtitle to all players satisfying the given predicate.

open fun broadcastFormattedTitle(title: String = "", subtitle: String = "", fadeIn: @Range(from = 0, to = 72000) Int, stay: @Range(from = 0, to = 72000) Int, fadeOut: @Range(from = 0, to = 72000) Int, predicate: Predicate = Predicate { true })

Broadcasts a formatted title to all eligible recipients.

sendFormattedActionBar

abstract fun P.sendFormattedActionBar(message: String)

Sends a formatted action bar message to the current player.

sendFormattedMessage

abstract fun CS.sendFormattedMessage(message: String)

Sends a formatted message to the current player or client system (CS).

sendFormattedPersistentTitle

abstract fun P.sendFormattedPersistentTitle(title: String = "", subtitle: String = "", fadeIn: @Range(from = 0, to = 72000) Int)

Sends a formatted, persistent title and subtitle to the current player or client system (P).

sendFormattedTitle

abstract fun P.sendFormattedTitle(title: String = "", subtitle: String = "")

Sends a formatted title and subtitle to the current player. The title and subtitle are displayed in the player's title bar.

abstract fun P.sendFormattedTitle(title: String = "", subtitle: String = "", fadeIn: @Range(from = 0, to = 72000) Int, stay: @Range(from = 0, to = 72000) Int, fadeOut: @Range(from = 0, to = 72000) Int)

Sends a formatted title and subtitle to the current player or client system (P).