me.ryandw11.ultrabar.api

Class BossBarBuilder

java.lang.Object

me.ryandw11.ultrabar.api.BossBarBuilder

public class BossBarBuilder
extends java.lang.Object

Clean way to create a bossbar via the plugin.

The recommended way

Author:

Ryandw11

Constructor Summary

Constructors

Constructor and Description
BossBarBuilder(boolean tracked) The api for building bossbars.

Method Summary

Modifier and Type	Method and Description
UBossBar	build() Build the bar (aka, create it).
UBossBar	buildDead() Create a permanent bar.
boolean	getPublicBar()
boolean	hasPlayers() If there are any players associated witht he bar.
boolean	isOnePlayer() If there is only one player associated with the bar.
BossBarBuilder	setColor(org.bukkit.boss.BarColor color) Set the color of the boss bar.
void	setData(java.lang.String key, java.lang.String value) Store data on the boss bar.
BossBarBuilder	setId(int id) Set the id of the bar.
BossBarBuilder	setMessage(java.lang.String s) Set the message of the boss bar.
BossBarBuilder	setPlayerCollection(java.util.Collection<org.bukkit.entity.Player> players) Set a collection of players.
BossBarBuilder	setProgress(double progress) Set the progress of the bossbar.
BossBarBuilder	setPublicBar(boolean bool)
BossBarBuilder	setSinglePlayer(org.bukkit.entity.Player p) Set a single player to a bar.
BossBarBuilder	setStyle(org.bukkit.boss.BarStyle style) Set the style of the boss bar.
BossBarBuilder	setTime(int time) Set the time of the bossbar.
BossBarBuilder	setTracked(boolean value)
BossBarBuilder	setWorld(org.bukkit.World w) Set the world a player/players need to be in.

Methods inherited from class java.lang.Object

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

Constructor Detail

BossBarBuilder

public BossBarBuilder(boolean tracked)

The api for building bossbars.

Parameters:

tracked - If the UBossBar class should be stored in the active bars list once built.

Method Detail

setMessage

public BossBarBuilder setMessage(java.lang.String s)

Set the message of the boss bar. Required

Parameters:

s -

setColor

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

Set the color of the boss bar. Required

Parameters:

color -

setStyle

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

Set the style of the boss bar. Required

Parameters:

style -

setTime

public BossBarBuilder setTime(int time)

Set the time of the bossbar. Required

Parameters:

time -

setProgress

public BossBarBuilder setProgress(double progress)

Set the progress of the bossbar. Required

Parameters:

progress -

setSinglePlayer

public BossBarBuilder setSinglePlayer(org.bukkit.entity.Player p)

Set a single player to a bar.

Parameters:

p - The player

setPlayerCollection

public BossBarBuilder setPlayerCollection(java.util.Collection<org.bukkit.entity.Player> players)

Set a collection of players.

Parameters:

players - The collection of players.

setWorld

public BossBarBuilder setWorld(org.bukkit.World w)

Set the world a player/players need to be in.

Parameters:

w -

setId

public BossBarBuilder setId(int id)

Set the id of the bar. (Can be used to retrieve the bar later)

Parameters:

id - The int id.

setTracked

public BossBarBuilder setTracked(boolean value)

isOnePlayer

public boolean isOnePlayer()

If there is only one player associated with the bar.

Returns:

true or false

getPublicBar

public boolean getPublicBar()

setPublicBar

public BossBarBuilder setPublicBar(boolean bool)

hasPlayers

public boolean hasPlayers()

If there are any players associated witht he bar.

setData

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

Store data on the boss bar.

Parameters:

key - The key for the data.

value - The data itself.

build

public UBossBar build()

Build the bar (aka, create it).

Returns:

The UBossBar class. Returns null if the setup is invalid

buildDead

public UBossBar buildDead()

Create a permanent bar.

Returns:

The UBossBar class. Returns null if the setup is invalid