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

Bungee

object Bungee : VitalUtils<BungeeCommandSender, BungeePlayer>

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

This object provides methods for broadcasting messages, sending formatted titles, messages, and action bar notifications specific to the BungeeCord environment. It operates on BungeeCommandSender and BungeePlayer types, enabling server-wide or player-specific interactions.

Functions

broadcastAction

open override fun broadcastAction(predicate: Predicate<BungeePlayer> = Predicate { true }, action: Consumer<BungeePlayer>)

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

broadcastFormattedActionBar

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

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

broadcastFormattedMessage

open fun broadcastFormattedMessage(message: String, predicate: Predicate<BungeePlayer> = 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<BungeePlayer> = 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 = "", fadeIn: @Range(from = 0, to = 72000) Int, stay: @Range(from = 0, to = 72000) Int, fadeOut: @Range(from = 0, to = 72000) Int, predicate: Predicate<BungeePlayer> = Predicate { true })

Broadcasts a formatted title to all eligible recipients.

open override fun broadcastFormattedTitle(title: String = "", subtitle: String = "", predicate: Predicate<BungeePlayer>)

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

sendFormattedActionBar

open override fun BungeePlayer.sendFormattedActionBar(message: String)

Sends a formatted action bar message to the current player.

sendFormattedMessage

open override fun BungeeCommandSender.sendFormattedMessage(message: String)

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

sendFormattedPersistentTitle

open override fun BungeePlayer.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

open override fun BungeePlayer.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.

open override fun BungeePlayer.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).