me.lucko.helper.bossbar

Interface BossBar

All Superinterfaces:

AutoCloseable, Terminable

public interface BossBar
extends Terminable

Generic interface for bossbars.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	addPlayer(org.bukkit.entity.Player player) Adds the player to this boss bar causing it to display on their screen.
default void	addPlayers(Iterable<org.bukkit.entity.Player> players) Adds the players to this boss bar causing it to display on their screens.
void	close() Closes this resource.
BossBarColor	color() Gets the color of this boss bar
BossBar	color(BossBarColor color) Sets the color of this boss bar.
List<org.bukkit.entity.Player>	players() Returns all players viewing this boss bar
double	progress() Gets the progress of the bar between 0.0 and 1.0
BossBar	progress(double progress) Sets the progress of the bar.
void	removeAll() Removes all players from this boss bar
void	removePlayer(org.bukkit.entity.Player player) Removes the player from this boss bar causing it to be removed from their screen.
default void	removePlayers(Iterable<org.bukkit.entity.Player> players) Removes the players from this boss bar causing it to be removed from their screens.
BossBarStyle	style() Gets the style of this boss bar
BossBar	style(BossBarStyle style) Sets the bar style of this boss bar
String	title() Gets the title of this boss bar
BossBar	title(String title) Sets the title of this boss bar
boolean	visible() Gets if the boss bar is displayed to attached players.
BossBar	visible(boolean visible) Set if the boss bar is displayed to attached players.

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

title

@Nonnull
String title()

Gets the title of this boss bar

Returns:

the title of the bar

title

@Nonnull
BossBar title(@Nonnull
                       String title)

Sets the title of this boss bar

Parameters:

title - the title of the bar

Returns:

this bar (for chaining)

progress

double progress()

Gets the progress of the bar between 0.0 and 1.0

Returns:

the progress of the bar

progress

@Nonnull
BossBar progress(double progress)

Sets the progress of the bar. Values should be between 0.0 (empty) and 1.0 (full)

Parameters:

progress - the progress of the bar

Returns:

this bar (for chaining)

color

@Nonnull
BossBarColor color()

Gets the color of this boss bar

Returns:

the color of the bar

color

@Nonnull
BossBar color(@Nonnull
                       BossBarColor color)

Sets the color of this boss bar.

Parameters:

color - the color of the bar

Returns:

this bar (for chaining)

style

@Nonnull
BossBarStyle style()

Gets the style of this boss bar

Returns:

the style of the bar

style

@Nonnull
BossBar style(@Nonnull
                       BossBarStyle style)

Sets the bar style of this boss bar

Parameters:

style - the style of the bar

Returns:

this bar (for chaining)

visible

boolean visible()

Gets if the boss bar is displayed to attached players.

Returns:

visible status

visible

@Nonnull
BossBar visible(boolean visible)

Set if the boss bar is displayed to attached players.

Parameters:

visible - visible status

Returns:

this bar (for chaining)

players

@Nonnull
List<org.bukkit.entity.Player> players()

Returns all players viewing this boss bar

Returns:

a immutable list of players

addPlayer

void addPlayer(@Nonnull
               org.bukkit.entity.Player player)

Adds the player to this boss bar causing it to display on their screen.

Parameters:

player - the player to add

removePlayer

void removePlayer(@Nonnull
                  org.bukkit.entity.Player player)

Removes the player from this boss bar causing it to be removed from their screen.

Parameters:

player - the player to remove

addPlayers

default void addPlayers(@Nonnull
                        Iterable<org.bukkit.entity.Player> players)

Adds the players to this boss bar causing it to display on their screens.

Parameters:

players - the players to add

removePlayers

default void removePlayers(@Nonnull
                           Iterable<org.bukkit.entity.Player> players)

Removes the players from this boss bar causing it to be removed from their screens.

Parameters:

players - the players to remove

removeAll

void removeAll()

Removes all players from this boss bar

close

void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable