us.myles.ViaVersion.api.boss

Class BossBar<T>

java.lang.Object

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

Direct Known Subclasses:

CommonBoss

public abstract class BossBar<T>
extends Object

Constructor Summary

Constructors

Constructor and Description
BossBar()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BossBar

public BossBar()

Method Detail

getTitle

public abstract String getTitle()

Get the current title

Returns:

the title

setTitle

public abstract BossBar setTitle(String title)

Change the title

Parameters:

title - Title can be in either JSON or just text

Returns:

The BossBar object

getHealth

public abstract float getHealth()

Get the health

Returns:

float between 0F - 1F

setHealth

public abstract BossBar setHealth(float health)

Change the health

Parameters:

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

Returns:

The BossBar object

getColor

public abstract BossColor getColor()

Get the bossbar color

Returns:

The colour

setColor

public abstract BossBar setColor(BossColor color)

Yay colors!

Parameters:

color - Whatever color you want!

Returns:

The BossBar object

getStyle

public abstract BossStyle getStyle()

Get the bosbar style

Returns:

BossStyle

setStyle

public abstract BossBar setStyle(BossStyle style)

Change the bosbar style

Parameters:

style - BossStyle

Returns:

The BossBar object

addPlayer

@Deprecated
public BossBar addPlayer(T player)

Deprecated. Deprecated use UUID's instead of Player objects addPlayer(UUID)

Show the bossbar to a player.

Parameters:

player - The player

Returns:

The BossBar object

addPlayer

public abstract BossBar addPlayer(UUID player)

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

Parameters:

player - uuid of the player

Returns:

The BossBar object

addConnection

public abstract BossBar addConnection(UserConnection conn)

Show the bossbar to a player connection.

Parameters:

conn - UserConnection of the connection

Returns:

The BossBar object

addPlayers

@Deprecated
public BossBar addPlayers(T... players)

Deprecated. Deprecated use UUID's instead of Player objects addPlayer(UUID)

add multiple players

Parameters:

players - list of players

Returns:

The BossBar object

removePlayer

@Deprecated
public BossBar removePlayer(T player)

Deprecated. Deprecated use UUID's instead of Player objects removePlayer(UUID)

Remove the bossbar from a player

Parameters:

player - The player

Returns:

The BossBar object

removePlayer

public abstract BossBar removePlayer(UUID uuid)

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

Parameters:

uuid - The players UUID

Returns:

The BossBar object

removeConnection

public abstract BossBar removeConnection(UserConnection conn)

Removes the bossbar from a player connection.

Parameters:

conn - The UserConnection

Returns:

The BossBar object

addFlag

public abstract BossBar addFlag(BossFlag flag)

Add flags

Parameters:

flag - The flag to add

Returns:

The BossBar object

removeFlag

public abstract BossBar removeFlag(BossFlag flag)

Remove flags.

Parameters:

flag - The flag to remove

Returns:

The BossBar object

hasFlag

public abstract boolean hasFlag(BossFlag flag)

Parameters:

flag - The flag to check against

Returns:

True if it has the flag

getPlayers

public abstract Set<UUID> getPlayers()

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

Returns:

UUIDS from players (sorry I lied)

getConnections

public abstract Set<UserConnection> getConnections()

Get UserConnections.

Returns:

UserConnection from players

show

public abstract BossBar show()

Show the bossbar to everyone (In the getPlayer set)

Returns:

The BossBar object

hide

public abstract BossBar hide()

Hide the bossbar from everyone (In the getPlayer set)

Returns:

The BossBar object

isVisible

public abstract boolean isVisible()

Is it visible?

Returns:

visibility changable with show() and hide()

getId

public abstract UUID getId()

Get the UUID of this bossbar

Returns:

Unique Id for this bossbar