Package io.lumine.mythic.bukkit.adapters.bossbars

Class AdventureBossBar

java.lang.Object

io.lumine.mythic.bukkit.adapters.bossbars.AdventureBossBar

All Implemented Interfaces:

AbstractBossBar, io.lumine.utils.terminable.Terminable, AutoCloseable

public class AdventureBossBar
extends Object
implements AbstractBossBar

Nested Class Summary

Nested classes/interfaces inherited from interface io.lumine.mythic.api.adapters.AbstractBossBar

AbstractBossBar.BarColor, AbstractBossBar.BarFlag, AbstractBossBar.BarStyle

Field Summary

Fields inherited from interface io.lumine.utils.terminable.Terminable

EMPTY

Constructor Summary

Constructors

Constructor	Description
AdventureBossBar(String title, float progress, AbstractBossBar.BarColor color, AbstractBossBar.BarStyle style)

Method Summary

Modifier and Type	Method	Description
void	addFlag(String flag)	Add an optional flag to this boss bar
void	addPlayer(AbstractPlayer player)	Adds the player to this boss bar causing it to display on their screen.
void	close()
AbstractBossBar.BarColor	getColor()	Returns the color of this boss bar
Collection<UUID>	getPlayerIds()
Collection<AbstractPlayer>	getPlayers()	Returns all players viewing this boss bar
double	getProgress()	Returns the progress of the bar between 0.0 and 1.0
AbstractBossBar.BarStyle	getStyle()	Returns the style of this boss bar
String	getTitle()	Returns the title of this boss bar
boolean	hasFlag(String flag)	Returns whether this boss bar as the passed flag set
boolean	isViewing(AbstractPlayer player)
boolean	isVisible()	Return if the boss bar is displayed to attached players.
void	removeAll()	Removes all players from this boss bar
void	removeFlag(String flag)	Remove an existing flag on this boss bar
void	removePlayer(AbstractPlayer player)	Removes the player from this boss bar causing it to be removed from their screen.
void	removePlayer(UUID player)
void	setColor(String color)	Sets the color of this boss bar.
void	setCreateFog(boolean b)
void	setDarkenSky(boolean b)
void	setPlayBossMusic(boolean b)
void	setProgress(double progress)	Sets the progress of the bar.
void	setStyle(String style)	Sets the bar style of this boss bar
void	setTitle(String title)	Sets the title of this boss bar
void	setVisible(boolean visible)	Set if the boss bar is displayed to attached players.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.lumine.utils.terminable.Terminable

bindWith, closeAndReportException, closeSilently, hasTerminated, isClosed, terminate

Constructor Details

AdventureBossBar

public AdventureBossBar(String title,
 float progress,
 AbstractBossBar.BarColor color,
 AbstractBossBar.BarStyle style)

Method Details

getTitle

public String getTitle()

Description copied from interface: AbstractBossBar

Returns the title of this boss bar

Specified by:

getTitle in interface AbstractBossBar

Returns:

the title of the bar

setTitle

public void setTitle(String title)

Description copied from interface: AbstractBossBar

Sets the title of this boss bar

Specified by:

setTitle in interface AbstractBossBar

Parameters:

title - the title of the bar

getColor

public AbstractBossBar.BarColor getColor()

Description copied from interface: AbstractBossBar

Returns the color of this boss bar

Specified by:

getColor in interface AbstractBossBar

Returns:

the color of the bar

setColor

public void setColor(String color)

Description copied from interface: AbstractBossBar

Sets the color of this boss bar.

Specified by:

setColor in interface AbstractBossBar

Parameters:

color - the color of the bar

getStyle

public AbstractBossBar.BarStyle getStyle()

Description copied from interface: AbstractBossBar

Returns the style of this boss bar

Specified by:

getStyle in interface AbstractBossBar

Returns:

the style of the bar

setStyle

public void setStyle(String style)

Description copied from interface: AbstractBossBar

Sets the bar style of this boss bar

Specified by:

setStyle in interface AbstractBossBar

Parameters:

style - the style of the bar

removeFlag

public void removeFlag(String flag)

Description copied from interface: AbstractBossBar

Remove an existing flag on this boss bar

Specified by:

removeFlag in interface AbstractBossBar

Parameters:

flag - the existing flag to remove

addFlag

public void addFlag(String flag)

Description copied from interface: AbstractBossBar

Add an optional flag to this boss bar

Specified by:

addFlag in interface AbstractBossBar

Parameters:

flag - an optional flag to set on the boss bar

hasFlag

public boolean hasFlag(String flag)

Description copied from interface: AbstractBossBar

Returns whether this boss bar as the passed flag set

Specified by:

hasFlag in interface AbstractBossBar

Parameters:

flag - the flag to check

Returns:

whether it has the flag

setProgress

public void setProgress(double progress)

Description copied from interface: AbstractBossBar

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

Specified by:

setProgress in interface AbstractBossBar

Parameters:

progress - the progress of the bar

getProgress

public double getProgress()

Description copied from interface: AbstractBossBar

Returns the progress of the bar between 0.0 and 1.0

Specified by:

getProgress in interface AbstractBossBar

Returns:

the progress of the bar

addPlayer

public void addPlayer(AbstractPlayer player)

Description copied from interface: AbstractBossBar

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

Specified by:

addPlayer in interface AbstractBossBar

Parameters:

player - the player to add

removePlayer

public void removePlayer(AbstractPlayer player)

Description copied from interface: AbstractBossBar

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

Specified by:

removePlayer in interface AbstractBossBar

Parameters:

player - the player to remove

removeAll

public void removeAll()

Description copied from interface: AbstractBossBar

Removes all players from this boss bar

Specified by:

removeAll in interface AbstractBossBar

See Also:

• AbstractBossBar.removeAll()

getPlayers

public Collection<AbstractPlayer> getPlayers()

Description copied from interface: AbstractBossBar

Returns all players viewing this boss bar

Specified by:

getPlayers in interface AbstractBossBar

Returns:

a immutable list of players

setVisible

public void setVisible(boolean visible)

Description copied from interface: AbstractBossBar

Set if the boss bar is displayed to attached players.

Specified by:

setVisible in interface AbstractBossBar

Parameters:

visible - visible status

isVisible

public boolean isVisible()

Description copied from interface: AbstractBossBar

Return if the boss bar is displayed to attached players.

Specified by:

isVisible in interface AbstractBossBar

Returns:

visible status

setCreateFog

public void setCreateFog(boolean b)

Specified by:

setCreateFog in interface AbstractBossBar

setDarkenSky

public void setDarkenSky(boolean b)

Specified by:

setDarkenSky in interface AbstractBossBar

setPlayBossMusic

public void setPlayBossMusic(boolean b)

Specified by:

setPlayBossMusic in interface AbstractBossBar

getPlayerIds

public Collection<UUID> getPlayerIds()

Specified by:

getPlayerIds in interface AbstractBossBar

removePlayer

public void removePlayer(UUID player)

Specified by:

removePlayer in interface AbstractBossBar

isViewing

public boolean isViewing(AbstractPlayer player)

Specified by:

isViewing in interface AbstractBossBar

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface io.lumine.utils.terminable.Terminable