io.lumine.xikage.mythicmobs.adapters

Interface AbstractBossBar

All Superinterfaces:

AutoCloseable, io.lumine.utils.terminable.Terminable

All Known Implementing Classes:

BukkitBossBar

public interface AbstractBossBar
extends io.lumine.utils.terminable.Terminable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AbstractBossBar.BarColor
static class	AbstractBossBar.BarFlag
static class	AbstractBossBar.BarStyle

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method and 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.
AbstractBossBar.BarColor	getColor() Returns the color of this boss bar
List<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	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	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 interface io.lumine.utils.terminable.Terminable

bindWith, close, closeAndReportException, closeSilently, hasTerminated, isClosed, terminate

Method Detail

getTitle

String getTitle()

Returns the title of this boss bar

Returns:

the title of the bar

setTitle

void setTitle(String title)

Sets the title of this boss bar

Parameters:

title - the title of the bar

getColor

AbstractBossBar.BarColor getColor()

Returns the color of this boss bar

Returns:

the color of the bar

setColor

void setColor(String color)

Sets the color of this boss bar.

Parameters:

color - the color of the bar

getStyle

AbstractBossBar.BarStyle getStyle()

Returns the style of this boss bar

Returns:

the style of the bar

setStyle

void setStyle(String style)

Sets the bar style of this boss bar

Parameters:

style - the style of the bar

removeFlag

void removeFlag(String flag)

Remove an existing flag on this boss bar

Parameters:

flag - the existing flag to remove

addFlag

void addFlag(String flag)

Add an optional flag to this boss bar

Parameters:

flag - an optional flag to set on the boss bar

hasFlag

boolean hasFlag(String flag)

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

void addPlayer(AbstractPlayer player)

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

Parameters:

player - the player to add

removePlayer

void removePlayer(AbstractPlayer player)

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:

removeAll()

getPlayers

List<AbstractPlayer> 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

setCreateFog

void setCreateFog(boolean b)

setDarkenSky

void setDarkenSky(boolean b)

setPlayBossMusic

void setPlayBossMusic(boolean b)