me.ryandw11.ultrabar.api

Class UBossBar

java.lang.Object

me.ryandw11.ultrabar.api.UBossBar

public class UBossBar
extends java.lang.Object

Any active bossbar on the server.

Since:

2.1

Author:

Ryandw11

Constructor Summary

Constructors

Constructor and Description
UBossBar(BossBarBuilder bbb, org.bukkit.boss.BossBar bar, BossBarTimer timer)

Method Summary

Modifier and Type	Method and Description
void	addPlayer(org.bukkit.entity.Player p) Add a player to the player Collection
boolean	containsKey(java.lang.String key) If a key exists
void	deleteData(java.lang.String key) Delete data from the stored data.
boolean	equals(java.lang.Object o)
org.bukkit.boss.BossBar	getBar()
org.bukkit.boss.BarColor	getColor()
java.lang.String	getData(java.lang.String key) Get a piece of data
int	getId() Get the id
java.lang.String	getMessage()
java.util.Map<java.lang.String,java.lang.String>	getParameters() Is null if the command was not use to form this bar.
java.util.UUID	getPID()
java.util.Collection<org.bukkit.entity.Player>	getPlayers() Get the players.
double	getProgress()
org.bukkit.boss.BarStyle	getStyle()
int	getTime()
BossBarTimer	getTimer() Get the timer asociated with the bar.
org.bukkit.World	getWorld()
int	hashCode()
boolean	isPublicBar() If the bar is a public bar.
boolean	isTracked()
void	removePlayer(org.bukkit.entity.Player p) A way to remove players as #remove does not work on Collections.
void	setBar(org.bukkit.boss.BossBar bar)
void	setColor(org.bukkit.boss.BarColor color)
void	setData(java.lang.String key, java.lang.String value) Set a data value
void	setMessage(java.lang.String message)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> param)
void	setPlayers(java.util.Collection<org.bukkit.entity.Player> players)
void	setProgress(double progress)
void	setPublic(boolean pub)
void	setStyle(org.bukkit.boss.BarStyle style)
void	setTime(int time)
void	setTracked(boolean tracked)
void	setWorld(org.bukkit.World world)
void	updatePlayers() Update the list of players on the live bar.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UBossBar

public UBossBar(BossBarBuilder bbb,
                org.bukkit.boss.BossBar bar,
                @Nullable
                BossBarTimer timer)

Parameters:

bbb - The instance of the builder.

timer - The time (Can be null)

Method Detail

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

getColor

public org.bukkit.boss.BarColor getColor()

setColor

public void setColor(org.bukkit.boss.BarColor color)

getStyle

public org.bukkit.boss.BarStyle getStyle()

setStyle

public void setStyle(org.bukkit.boss.BarStyle style)

getTime

public int getTime()

setTime

public void setTime(int time)

getProgress

public double getProgress()

setPublic

public void setPublic(boolean pub)

setProgress

public void setProgress(double progress)

setData

public void setData(java.lang.String key,
                    java.lang.String value)

Set a data value

Parameters:

key - the key

value - the data

containsKey

public boolean containsKey(java.lang.String key)

If a key exists

Parameters:

key - the key

Returns:

if the key exists

getData

public java.lang.String getData(java.lang.String key)

Get a piece of data

Parameters:

key - The key

Returns:

The piece of data.

deleteData

public void deleteData(java.lang.String key)

Delete data from the stored data.

Parameters:

key - The key to delete.

getId

public int getId()

Get the id

Returns:

The id.

getPlayers

public java.util.Collection<org.bukkit.entity.Player> getPlayers()

Get the players.

Note: If you want to remove players use removePlayer(Player)

Returns:

A collection of players.

removePlayer

public void removePlayer(org.bukkit.entity.Player p)

A way to remove players as #remove does not work on Collections.

Parameters:

p - The player.

addPlayer

public void addPlayer(org.bukkit.entity.Player p)

Add a player to the player Collection

Parameters:

p - the player

setPlayers

public void setPlayers(java.util.Collection<org.bukkit.entity.Player> players)

getWorld

public org.bukkit.World getWorld()

setWorld

public void setWorld(org.bukkit.World world)

isTracked

public boolean isTracked()

setTracked

public void setTracked(boolean tracked)

getTimer

public BossBarTimer getTimer()

Get the timer asociated with the bar.

Returns:

The BossBarTimer class. (Null if the bar has not BossBarTimer associated)

getBar

public org.bukkit.boss.BossBar getBar()

setBar

public void setBar(org.bukkit.boss.BossBar bar)

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Is null if the command was not use to form this bar.

Returns:

Parameters or null.

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> param)

updatePlayers

public void updatePlayers()

Update the list of players on the live bar.

getPID

public java.util.UUID getPID()

isPublicBar

public boolean isPublicBar()

If the bar is a public bar.

Returns:

true or false.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object