Index

A B C F G H I L O P R S T V
All Classes and Interfaces|All Packages

A

actionBar() - Method in interface com.cotani.hud.api.HudModule

Returns the ActionBar manager.

ActionBarController - Interface in com.cotani.hud.api

Manager for sending and maintaining player action bar displays.

adventureBar() - Method in interface com.cotani.hud.api.HudBossBar

Returns the underlying Adventure BossBar.

apply(Player) - Method in interface com.cotani.hud.api.SidebarBuilder

Builds and attaches the sidebar to the given player.

B

bind(Player, Property, Function) - Method in interface com.cotani.hud.api.ActionBarController

Binds the action bar to a reactive property.

bindFooter(Player, Property, Function) - Method in interface com.cotani.hud.api.TabListController

Binds the tab list footer to a reactive property.

bindHeader(Player, Property, Function) - Method in interface com.cotani.hud.api.TabListController

Binds the tab list header to a reactive property.

bindLine(int, Property, Function) - Method in interface com.cotani.hud.api.Sidebar

Binds a line to a reactive Property, updating automatically on changes.

bindLine(int, Property, Function) - Method in interface com.cotani.hud.api.SidebarBuilder

Binds a line to a reactive property.

bindProgress(Property) - Method in interface com.cotani.hud.api.HudBossBar

Binds progress to a reactive property.

bindTitle(Property, Function) - Method in interface com.cotani.hud.api.HudBossBar

Binds title to a reactive property.

bindTitle(Property, Function) - Method in interface com.cotani.hud.api.SidebarBuilder

Binds the title to a reactive property.

bossBar() - Method in interface com.cotani.hud.api.HudModule

Returns the BossBar manager.

BossBarBuilder - Interface in com.cotani.hud.api

Fluent builder for creating HudBossBar instances.

BossBarController - Interface in com.cotani.hud.api

Manager for creating and tracking active HudBossBar instances.

build() - Method in interface com.cotani.hud.api.BossBarBuilder

Builds and registers the managed boss bar.

builder() - Method in interface com.cotani.hud.api.BossBarController

Creates a new fluent boss bar builder.

C

clear(Player) - Method in interface com.cotani.hud.api.ActionBarController

Clears any active timed or bound action bar for the player.

clear(Player) - Method in interface com.cotani.hud.api.BossBarController

Hides and removes all boss bars for a player.

clear(Player) - Method in interface com.cotani.hud.api.HudModule

Clears all HUD components (sidebar, tablist, bossbars, actionbar) for the given player.

clear(Player) - Method in interface com.cotani.hud.api.TabListController

Clears tab list header and footer for the player.

close() - Method in interface com.cotani.hud.api.HudBossBar

Destroys this boss bar and hides it from all viewers.

close() - Method in interface com.cotani.hud.api.HudModule

Disposes the module, clearing all HUD elements and unregistering listeners.

close() - Method in interface com.cotani.hud.api.Sidebar

Destroys this sidebar and detaches the scoreboard from the player.

color(BossBar.Color) - Method in interface com.cotani.hud.api.BossBarBuilder

Sets the color of the boss bar.

color(BossBar.Color) - Method in interface com.cotani.hud.api.HudBossBar

Updates the bar color.

com.cotani.hud - package com.cotani.hud

com.cotani.hud.api - package com.cotani.hud.api

CotaniHuds - Class in com.cotani.hud

Main factory for bootstrapping and configuring the Cotani HUD module.

countdown(Duration) - Method in interface com.cotani.hud.api.BossBarBuilder

Configures a countdown timer that decrements progress to 0 and closes the bar when finished.

create(Plugin, PaperTaskScheduler) - Static method in class com.cotani.hud.CotaniHuds

Creates and registers a new HudModule instance.

F

flags(Set) - Method in interface com.cotani.hud.api.BossBarBuilder

Sets the boss bar flags.

G

getBars(Player) - Method in interface com.cotani.hud.api.BossBarController

Returns all active managed boss bars for a given player.

getSidebar(UUID) - Method in interface com.cotani.hud.api.HudModule

Returns the active sidebar for a player UUID if present.

getSidebar(Player) - Method in interface com.cotani.hud.api.HudModule

Returns the active sidebar for a player if present.

H

hide(Player) - Method in interface com.cotani.hud.api.HudBossBar

Hides the boss bar from a player.

HudBossBar - Interface in com.cotani.hud.api

Represents an active, managed BossBar instance.

HudModule - Interface in com.cotani.hud.api

Central Cotani HUD module providing sidebars, tablist, bossbars, and actionbars.

I

isDestroyed() - Method in interface com.cotani.hud.api.HudBossBar

Returns whether this boss bar is destroyed.

isDestroyed() - Method in interface com.cotani.hud.api.Sidebar

Returns whether this sidebar is destroyed.

L

line(int, String) - Method in interface com.cotani.hud.api.Sidebar

Updates a line score value immediately from a MiniMessage string.

line(int, String) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets a static line at the given score index from a MiniMessage string.

line(int, Function) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets a dynamic line provider evaluated per player.

line(int, Supplier) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets a dynamic line provider.

line(int, Component) - Method in interface com.cotani.hud.api.Sidebar

Updates a line score value immediately.

line(int, Component) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets a static line at the given score index.

O

overlay(BossBar.Overlay) - Method in interface com.cotani.hud.api.BossBarBuilder

Sets the overlay of the boss bar.

overlay(BossBar.Overlay) - Method in interface com.cotani.hud.api.HudBossBar

Updates the bar overlay.

P

progress(float) - Method in interface com.cotani.hud.api.BossBarBuilder

Sets the initial progress (0.0 to 1.0).

progress(float) - Method in interface com.cotani.hud.api.HudBossBar

Updates the bar progress (0.0 to 1.0).

R

refresh() - Method in interface com.cotani.hud.api.Sidebar

Refreshes all lines and title on the player's thread.

removeLine(int) - Method in interface com.cotani.hud.api.Sidebar

Removes a line by score.

S

send(Player, String) - Method in interface com.cotani.hud.api.ActionBarController

Sends an action bar message once from a MiniMessage string.

send(Player, Component) - Method in interface com.cotani.hud.api.ActionBarController

Sends an action bar message once.

sendTimed(Player, String, Duration) - Method in interface com.cotani.hud.api.ActionBarController

Sends and maintains an action bar message for the specified duration from a MiniMessage string.

sendTimed(Player, Component, Duration) - Method in interface com.cotani.hud.api.ActionBarController

Sends and maintains an action bar message for the specified duration.

setFooter(Player, String) - Method in interface com.cotani.hud.api.TabListController

Sets the footer for a player from a MiniMessage string.

setFooter(Player, Component) - Method in interface com.cotani.hud.api.TabListController

Sets the footer for a player.

setHeader(Player, String) - Method in interface com.cotani.hud.api.TabListController

Sets the header for a player from a MiniMessage string.

setHeader(Player, Component) - Method in interface com.cotani.hud.api.TabListController

Sets the header for a player.

setHeaderAndFooter(Player, String, String) - Method in interface com.cotani.hud.api.TabListController

Sets both header and footer for a player from MiniMessage strings.

setHeaderAndFooter(Player, Component, Component) - Method in interface com.cotani.hud.api.TabListController

Sets both header and footer for a player.

show(Player) - Method in interface com.cotani.hud.api.BossBarBuilder

Builds, registers, and shows the boss bar to the specified player.

show(Player) - Method in interface com.cotani.hud.api.HudBossBar

Shows the boss bar to a player.

sidebar() - Method in interface com.cotani.hud.api.HudModule

Creates a new fluent SidebarBuilder.

Sidebar - Interface in com.cotani.hud.api

Represents an active per-player sidebar (scoreboard) display.

SidebarBuilder - Interface in com.cotani.hud.api

Fluent builder for creating per-player Sidebar instances.

T

tabList() - Method in interface com.cotani.hud.api.HudModule

Returns the TabList manager.

TabListController - Interface in com.cotani.hud.api

Manager for player tab list header and footer presentations.

title(String) - Method in interface com.cotani.hud.api.BossBarBuilder

Sets the title of the boss bar from a MiniMessage string.

title(String) - Method in interface com.cotani.hud.api.HudBossBar

Updates the bar title from a MiniMessage string.

title(String) - Method in interface com.cotani.hud.api.Sidebar

Updates the title of the sidebar immediately from a MiniMessage string.

title(String) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets the static title of the sidebar from a MiniMessage string.

title(Supplier) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets a dynamic title provider.

title(Component) - Method in interface com.cotani.hud.api.BossBarBuilder

Sets the title of the boss bar.

title(Component) - Method in interface com.cotani.hud.api.HudBossBar

Updates the bar title.

title(Component) - Method in interface com.cotani.hud.api.Sidebar

Updates the title of the sidebar immediately.

title(Component) - Method in interface com.cotani.hud.api.SidebarBuilder

Sets the static title of the sidebar.

V

viewer() - Method in interface com.cotani.hud.api.Sidebar

Returns the active viewer player if online.

viewerId() - Method in interface com.cotani.hud.api.Sidebar

Returns the unique identifier of the viewer player.

viewerIds() - Method in interface com.cotani.hud.api.HudBossBar

Returns the UUIDs of all current viewers.

viewers() - Method in interface com.cotani.hud.api.HudBossBar

Returns all current viewers that are currently online.

A B C F G H I L O P R S T V
All Classes and Interfaces|All Packages