Package org.bukkit.boss
Interface BossBar
- All Known Subinterfaces:
KeyedBossBar
public interface BossBar
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add an optional flag to this boss barvoid
Adds the player to this boss bar causing it to display on their screen.getColor()
Returns the color of this boss barReturns all players viewing this boss bardouble
Returns the progress of the bar between 0.0 and 1.0getStyle()
Returns the style of this boss bargetTitle()
Returns the title of this boss barboolean
Returns whether this boss bar as the passed flag setvoid
hide()
Deprecated.boolean
Return if the boss bar is displayed to attached players.void
Removes all players from this boss barvoid
removeFlag
(@NotNull BarFlag flag) Remove an existing flag on this boss barvoid
removePlayer
(@NotNull Player player) Removes the player from this boss bar causing it to be removed from their screen.void
Sets the color of this boss bar.void
setProgress
(double progress) Sets the progress of the bar.void
Sets the bar style of this boss barvoid
Sets the title of this boss barvoid
setVisible
(boolean visible) Set if the boss bar is displayed to attached players.void
show()
Deprecated.
-
Method Details
-
getTitle
Returns the title of this boss bar- Returns:
- the title of the bar
-
setTitle
Sets the title of this boss bar- Parameters:
title
- the title of the bar
-
getColor
Returns the color of this boss bar- Returns:
- the color of the bar
-
setColor
Sets the color of this boss bar.- Parameters:
color
- the color of the bar
-
getStyle
Returns the style of this boss bar- Returns:
- the style of the bar
-
setStyle
Sets the bar style of this boss bar- Parameters:
style
- the style of the bar
-
removeFlag
Remove an existing flag on this boss bar- Parameters:
flag
- the existing flag to remove
-
addFlag
Add an optional flag to this boss bar- Parameters:
flag
- an optional flag to set on the boss bar
-
hasFlag
Returns whether this boss bar as the passed flag set- Parameters:
flag
- the flag to check- Returns:
- whether it has the flag
-
setProgress
void setProgress(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
-
getProgress
double getProgress()Returns the progress of the bar between 0.0 and 1.0- Returns:
- the progress of the bar
-
addPlayer
Adds the player to this boss bar causing it to display on their screen.- Parameters:
player
- the player to add
-
removePlayer
Removes the player from this boss bar causing it to be removed from their screen.- Parameters:
player
- the player to remove
-
removeAll
void removeAll()Removes all players from this boss bar- See Also:
-
getPlayers
Returns all players viewing this boss bar- Returns:
- a immutable list of players
-
setVisible
void setVisible(boolean visible) Set if the boss bar is displayed to attached players.- Parameters:
visible
- visible status
-
isVisible
boolean isVisible()Return if the boss bar is displayed to attached players.- Returns:
- visible status
-
show
Deprecated.Shows the previously hidden boss bar to all attached players -
hide
Deprecated.Hides this boss bar from all attached players
-
setVisible(boolean)