scoreboard-api/com.peco2282.devcore.scoreboard.api/bossBar

bossBar

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

Creates and returns a BossBarHandle using a DSL.

Example usage:

val handle = bossBar(Component.text("Boss Health")) {
    progress { player -> getBossHealth(player) }
    color(BossBar.Color.RED)
    overlay(BossBar.Overlay.PROGRESS)
}
handle.show(player)

Return

A new BossBarHandle.

Parameters

block

The builder block to configure the boss bar.

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

Creates and returns a BossBarHandle with a title.

Return

A new BossBarHandle.

Parameters

title

The title of the boss bar.

block

The builder block to configure the boss bar.

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

Creates and returns a BossBarHandle with a dynamic title.

Return

A new BossBarHandle.

Parameters

title

A function providing the title of the boss bar.

block

The builder block to configure the boss bar.

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

Creates and returns a BossBarHandle with auto-refresh enabled.

Return

A new BossBarHandle.

Parameters

block

The builder block to configure the boss bar.

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

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

Return

A new BossBarHandle.

Parameters

title

The title of the boss bar.

block

The builder block to configure the boss bar.

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

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

Return

A new BossBarHandle.

Parameters

title

A function providing the title of the boss bar.

block

The builder block to configure the boss bar.

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

Creates and returns a BossBarHandle with a specific refresh interval.

Receiver

The plugin instance.

Return

A new BossBarHandle.

Parameters

refreshInterval

The interval at which the boss bar should refresh.

block

The builder block to configure the boss bar.

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

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

Receiver

The plugin instance.

Return

A new BossBarHandle.

Parameters

refreshInterval

The interval at which the boss bar should refresh.

title

The title of the boss bar.

block

The builder block to configure the boss bar.

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.

Receiver

The plugin instance.

Return

A new BossBarHandle.

Parameters

refreshInterval

The interval at which the boss bar should refresh.

title

A function providing the title of the boss bar.

block

The builder block to configure the boss bar.