Package-level declarations

Types

Link copied to clipboard
interface BossBarHandle : Handle

A specialized handle for managing boss bars.

Link copied to clipboard
class DefaultBossBarHandle(title: (Player) -> Component, progress: (Player) -> Float, bar: BossBar, plugin: Plugin?, refreshInterval: Ticks?, visibilityCondition: (Player) -> Boolean?) : BossBarHandle

A default implementation of BossBarHandle using the Adventure API. This handle manages the visibility and content of a BossBar for multiple players.

Link copied to clipboard
interface Handle

Represents a generic handle for managing display elements like scoreboards or boss bars.

Link copied to clipboard
class PaperSidebarHandle(title: () -> Component, lines: List<(Player) -> Component>, plugin: Plugin?, refreshInterval: Ticks?) : SidebarHandle
Link copied to clipboard
object ScoreboardApi : Listener

ScoreboardApi is the entry point for the scoreboard and boss bar system. It manages Handle instances and provides access to the ScoreboardFactory.

Link copied to clipboard
interface SidebarHandle : Handle

A specialized handle for managing sidebars (scoreboards).

Functions

Link copied to clipboard
inline fun bossBar(block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle using a DSL.

inline fun bossBar(noinline title: () -> Component, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a dynamic title.

inline fun bossBar(title: Component, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a title.

Link copied to clipboard
inline fun Plugin.bossBar(block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with auto-refresh enabled.

inline fun Plugin.bossBar(refreshInterval: Ticks, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a specific refresh interval.

inline fun Plugin.bossBar(noinline title: () -> Component, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a dynamic title and auto-refresh.

inline fun Plugin.bossBar(title: Component, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a title and auto-refresh.

inline fun Plugin.bossBar(refreshInterval: Ticks, noinline title: () -> Component, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a specific refresh interval and dynamic title.

inline fun Plugin.bossBar(refreshInterval: Ticks, title: Component, block: BossBarBuilder.() -> Unit): BossBarHandle

Creates and returns a BossBarHandle with a specific refresh interval and title.

Link copied to clipboard
inline fun sidebar(noinline title: () -> Component, block: SidebarBuilder.() -> Unit): SidebarHandle

Creates and returns a SidebarHandle using a DSL with a dynamic title.

inline fun sidebar(title: Component, block: SidebarBuilder.() -> Unit): SidebarHandle

Creates and returns a SidebarHandle using a DSL.

Link copied to clipboard
inline fun Plugin.sidebar(noinline title: () -> Component, block: SidebarBuilder.() -> Unit): SidebarHandle
inline fun Plugin.sidebar(title: Component, block: SidebarBuilder.() -> Unit): SidebarHandle

Creates and returns a SidebarHandle with auto-refresh enabled for the plugin.

inline fun Plugin.sidebar(refreshInterval: Ticks, noinline title: () -> Component, block: SidebarBuilder.() -> Unit): SidebarHandle

Creates and returns a SidebarHandle with a specific refresh interval and dynamic title.

inline fun Plugin.sidebar(refreshInterval: Ticks, title: Component, block: SidebarBuilder.() -> Unit): SidebarHandle

Creates and returns a SidebarHandle with a specific refresh interval.

Link copied to clipboard
fun Player.team(name: String, block: Team.() -> Unit)

DSL for managing scoreboard teams for player name decoration (Prefix/Suffix).