com.velocitypowered.api.util.bossbar

Interface BossBar

public interface BossBar

Represents a boss bar, which can be send to a (group of) player(s). Boss bars only work on 1.9 and above.

Method Summary

Modifier and Type	Method and Description
void	addFlags(BossBarFlag... flags) Adds new flags to the boss bar.
void	addPlayer(Player player) Adds player to this boss bar.
void	addPlayers(Iterable<Player> players) Adds all specified players to this boss bar.
BossBarColor	getColor() Gets the color of the boss bar.
Collection<BossBarFlag>	getFlags() Returns a copy of of the Collection of all BossBarFlags added to the boss bar.
BossBarOverlay	getOverlay() Gets the overlay of the boss bar.
float	getPercent() Gets the boss bar's percent.
Collection<Player>	getPlayers() Returns a copy of the Collection of all Player added to the boss bar.
Component	getTitle() Gets the title of this boss bar.
boolean	isVisible() Returns whenever this boss bar is visible to all added getPlayers().
void	removeAllPlayers() Removes all players, that see this boss bar.
void	removeFlag(BossBarFlag flag) Removes flag from the boss bar.
void	removeFlags(BossBarFlag... flags) Removes flags from the boss bar.
void	removePlayer(Player player) Removes player from this boss bar.
void	removePlayers(Iterable<Player> players) Removes all specified players from this boss bar.
void	setColor(BossBarColor color) Sets a new color of the boss bar.
void	setOverlay(BossBarOverlay overlay) Sets a new overlay of the boss bar.
void	setPercent(float percent) Sets a new percent of the boss bar.
void	setTitle(Component title) Sets a new title of the boss bar.
void	setVisible(boolean visible) Sets a new visibility to the boss bar.

Method Detail

addPlayers

void addPlayers(Iterable<Player> players)

Adds all specified players to this boss bar.

Parameters:

players - players

See Also:

addPlayer(Player)

addPlayer

void addPlayer(Player player)

Adds player to this boss bar. This adds the player to the getPlayers() and makes him see the boss bar.

Parameters:

player - the player you wish to add

removePlayer

void removePlayer(Player player)

Removes player from this boss bar. This removes the player from getPlayers() and makes him not see the boss bar.

Parameters:

player - the player you wish to remove

removePlayers

void removePlayers(Iterable<Player> players)

Removes all specified players from this boss bar.

Parameters:

players - players

See Also:

removePlayer(Player)

removeAllPlayers

void removeAllPlayers()

Removes all players, that see this boss bar.

See Also:

removePlayer(Player)

getTitle

Component getTitle()

Gets the title of this boss bar.

Returns:

title

setTitle

void setTitle(Component title)

Sets a new title of the boss bar.

Parameters:

title - new title

getPercent

float getPercent()

Gets the boss bar's percent.

Returns:

percent

setPercent

void setPercent(float percent)

Sets a new percent of the boss bar.

Parameters:

percent - a float between 0 and 1, representing boss bar's percent

Throws:

IllegalArgumentException - if the new percent is not between 0 and 1

getPlayers

Collection<Player> getPlayers()

Returns a copy of the Collection of all Player added to the boss bar. Can be empty.

Returns:

players

getColor

BossBarColor getColor()

Gets the color of the boss bar.

Returns:

boss bar color

setColor

void setColor(BossBarColor color)

Sets a new color of the boss bar.

Parameters:

color - the color you wish the boss bar be displayed with

getOverlay

BossBarOverlay getOverlay()

Gets the overlay of the boss bar.

Returns:

boss bar overlay

setOverlay

void setOverlay(BossBarOverlay overlay)

Sets a new overlay of the boss bar.

Parameters:

overlay - the overlay you wish the boss bar be displayed with

isVisible

boolean isVisible()

Returns whenever this boss bar is visible to all added getPlayers(). By default, it returns true.

Returns:

true if visible, otherwise false

setVisible

void setVisible(boolean visible)

Sets a new visibility to the boss bar.

Parameters:

visible - boss bar visibility value

getFlags

Collection<BossBarFlag> getFlags()

Returns a copy of of the Collection of all BossBarFlags added to the boss bar.

Returns:

flags

addFlags

void addFlags(BossBarFlag... flags)

Adds new flags to the boss bar.

Parameters:

flags - the flags you wish to add

removeFlag

void removeFlag(BossBarFlag flag)

Removes flag from the boss bar.

Parameters:

flag - the flag you wish to remove

removeFlags

void removeFlags(BossBarFlag... flags)

Removes flags from the boss bar.

Parameters:

flags - the flags you wish to remove