us.myles.ViaVersion.boss

Class CommonBoss<T>

java.lang.Object

us.myles.ViaVersion.api.boss.BossBar<T>

us.myles.ViaVersion.boss.CommonBoss<T>

Direct Known Subclasses:

BungeeBossBar, SpongeBossBar, VelocityBossBar, ViaBossBar

public abstract class CommonBoss<T>
extends BossBar<T>

Constructor Summary

Constructors

Constructor and Description
CommonBoss(String title, float health, BossColor color, BossStyle style)

Method Summary

Modifier and Type	Method and Description
BossBar	addConnection(UserConnection conn) Show the bossbar to a player connection.
BossBar	addFlag(BossFlag flag) Add flags
BossBar	addPlayer(UUID player) Show the bossbar to a player (uuid).
BossColor	getColor() Get the bossbar color
Set<UserConnection>	getConnections() Get UserConnections.
Set<BossFlag>	getFlags()
float	getHealth() Get the health
UUID	getId() Get the UUID of this bossbar
Set<UUID>	getPlayers() Get players.
BossStyle	getStyle() Get the bosbar style
String	getTitle() Get the current title
UUID	getUuid()
boolean	hasFlag(BossFlag flag)
BossBar	hide() Hide the bossbar from everyone (In the getPlayer set)
boolean	isVisible() Is it visible?
BossBar	removeConnection(UserConnection conn) Removes the bossbar from a player connection.
BossBar	removeFlag(BossFlag flag) Remove flags.
BossBar	removePlayer(UUID uuid) Removes the bossbar from a player.
BossBar	setColor(BossColor color) Yay colors!
BossBar	setHealth(float health) Change the health
BossBar	setStyle(BossStyle style) Change the bosbar style
BossBar	setTitle(String title) Change the title
BossBar	show() Show the bossbar to everyone (In the getPlayer set)

Methods inherited from class us.myles.ViaVersion.api.boss.BossBar

addPlayer, addPlayers, removePlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonBoss

public CommonBoss(String title,
                  float health,
                  BossColor color,
                  BossStyle style)

Method Detail

setTitle

public BossBar setTitle(String title)

Description copied from class: BossBar

Change the title

Specified by:

setTitle in class BossBar<T>

Parameters:

title - Title can be in either JSON or just text

Returns:

The BossBar object

setHealth

public BossBar setHealth(float health)

Description copied from class: BossBar

Change the health

Specified by:

setHealth in class BossBar<T>

Parameters:

health - this float has to be between 0F - 1F

Returns:

The BossBar object

getColor

public BossColor getColor()

Description copied from class: BossBar

Get the bossbar color

Specified by:

getColor in class BossBar<T>

Returns:

The colour

setColor

public BossBar setColor(BossColor color)

Description copied from class: BossBar

Yay colors!

Specified by:

setColor in class BossBar<T>

Parameters:

color - Whatever color you want!

Returns:

The BossBar object

setStyle

public BossBar setStyle(BossStyle style)

Description copied from class: BossBar

Change the bosbar style

Specified by:

setStyle in class BossBar<T>

Parameters:

style - BossStyle

Returns:

The BossBar object

addPlayer

public BossBar addPlayer(UUID player)

Description copied from class: BossBar

Show the bossbar to a player (uuid). This only works for frontend connections. Use #addConnection(UserConnection) for other types.

Specified by:

addPlayer in class BossBar<T>

Parameters:

player - uuid of the player

Returns:

The BossBar object

addConnection

public BossBar addConnection(UserConnection conn)

Description copied from class: BossBar

Show the bossbar to a player connection.

Specified by:

addConnection in class BossBar<T>

Parameters:

conn - UserConnection of the connection

Returns:

The BossBar object

removePlayer

public BossBar removePlayer(UUID uuid)

Description copied from class: BossBar

Removes the bossbar from a player. This only works for frontend connections. For others types, use #removeConnection(UserConnection)

Specified by:

removePlayer in class BossBar<T>

Parameters:

uuid - The players UUID

Returns:

The BossBar object

removeConnection

public BossBar removeConnection(UserConnection conn)

Description copied from class: BossBar

Removes the bossbar from a player connection.

Specified by:

removeConnection in class BossBar<T>

Parameters:

conn - The UserConnection

Returns:

The BossBar object

addFlag

public BossBar addFlag(BossFlag flag)

Description copied from class: BossBar

Add flags

Specified by:

addFlag in class BossBar<T>

Parameters:

flag - The flag to add

Returns:

The BossBar object

removeFlag

public BossBar removeFlag(BossFlag flag)

Description copied from class: BossBar

Remove flags.

Specified by:

removeFlag in class BossBar<T>

Parameters:

flag - The flag to remove

Returns:

The BossBar object

hasFlag

public boolean hasFlag(BossFlag flag)

Specified by:

hasFlag in class BossBar<T>

Parameters:

flag - The flag to check against

Returns:

True if it has the flag

getPlayers

public Set<UUID> getPlayers()

Description copied from class: BossBar

Get players. Only returns UUIDs which are front-end. For all connections, use #getConnections()

Specified by:

getPlayers in class BossBar<T>

Returns:

UUIDS from players (sorry I lied)

getConnections

public Set<UserConnection> getConnections()

Description copied from class: BossBar

Get UserConnections.

Specified by:

getConnections in class BossBar<T>

Returns:

UserConnection from players

show

public BossBar show()

Description copied from class: BossBar

Show the bossbar to everyone (In the getPlayer set)

Specified by:

show in class BossBar<T>

Returns:

The BossBar object

hide

public BossBar hide()

Description copied from class: BossBar

Hide the bossbar from everyone (In the getPlayer set)

Specified by:

hide in class BossBar<T>

Returns:

The BossBar object

isVisible

public boolean isVisible()

Description copied from class: BossBar

Is it visible?

Specified by:

isVisible in class BossBar<T>

Returns:

visibility changable with show() and hide()

getId

public UUID getId()

Description copied from class: BossBar

Get the UUID of this bossbar

Specified by:

getId in class BossBar<T>

Returns:

Unique Id for this bossbar

getUuid

public UUID getUuid()

getTitle

public String getTitle()

Description copied from class: BossBar

Get the current title

Specified by:

getTitle in class BossBar<T>

Returns:

the title

getHealth

public float getHealth()

Description copied from class: BossBar

Get the health

Specified by:

getHealth in class BossBar<T>

Returns:

float between 0F - 1F

getStyle

public BossStyle getStyle()

Description copied from class: BossBar

Get the bosbar style

Specified by:

getStyle in class BossBar<T>

Returns:

BossStyle

getFlags

public Set<BossFlag> getFlags()