me.ryandw11.ultrabar.api

Class UltraBarAPI

java.lang.Object

me.ryandw11.ultrabar.api.UltraBarAPI

public class UltraBarAPI
extends java.lang.Object

Removed depracted #sendBossBar in version 2.1. api.bars.BossBarBuilder

Author:

Ryandw11

Constructor Summary

Constructors

Constructor and Description
UltraBarAPI()

Method Summary

Modifier and Type	Method and Description
void	addToggledPlayer(org.bukkit.entity.Player p) Add a player to the toggled list.
void	deleteBar(UBossBar bar) Delete a bar.
java.util.List<UBossBar>	getBarsForPlayer(org.bukkit.entity.Player p) Find all active bars with a player.
java.util.List<UBossBar>	getBarsWithId(int id) Find all active bars with a certain id.
UBossBar	getBarWithPid(java.util.UUID pid) Get a bar with a certain pid.
java.util.List<org.bukkit.entity.Player>	getToggledPlayers() Grab the list of toggled players.
java.util.List<UBossBar>	getTrackedBars() Grab the active bossbars.
void	registerParameter(BarParameter bp) Register a bar parameter.
void	removeToggledPlayer(org.bukkit.entity.Player p) Add a player to the toggled list.
void	sendActionBar(org.bukkit.entity.Player p, java.lang.String message) Send an action bar using the plugin.
void	sendTitle(org.bukkit.entity.Player p, java.lang.String title, java.lang.String subtitle, int fadein, int time, int fadeout) Send a title using the system.

Methods inherited from class java.lang.Object

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

Constructor Detail

UltraBarAPI

public UltraBarAPI()

Method Detail

sendTitle

public void sendTitle(org.bukkit.entity.Player p,
                      java.lang.String title,
                      java.lang.String subtitle,
                      int fadein,
                      int time,
                      int fadeout)

Send a title using the system.

Parameters:

p -

title -

subtitle -

fadein -

time -

fadeout -

sendActionBar

public void sendActionBar(org.bukkit.entity.Player p,
                          java.lang.String message)

Send an action bar using the plugin. (Automaticly gets the server version. NMS is handled with the plugin).

Parameters:

p -

message -

getTrackedBars

public java.util.List<UBossBar> getTrackedBars()

Grab the active bossbars.

Returns:

A list of active bars.

Since:

2.1.3

getToggledPlayers

public java.util.List<org.bukkit.entity.Player> getToggledPlayers()

Grab the list of toggled players. (API Use)

Returns:

addToggledPlayer

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

Add a player to the toggled list. (API Use)

Parameters:

p -

removeToggledPlayer

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

Add a player to the toggled list. (API Use)

Parameters:

p -

getBarsForPlayer

public java.util.List<UBossBar> getBarsForPlayer(org.bukkit.entity.Player p)

Find all active bars with a player.

Parameters:

p - The player you want to find bars for.

Returns:

Active bars for a player.

Since:

2.1

getBarsWithId

public java.util.List<UBossBar> getBarsWithId(int id)

Find all active bars with a certain id.

Parameters:

id - The int id of the bar.

Returns:

Active bars for the id.

Since:

2.1.1

registerParameter

public void registerParameter(BarParameter bp)

Register a bar parameter.

Parameters:

bp - The parameter to register.

getBarWithPid

public UBossBar getBarWithPid(java.util.UUID pid)

Get a bar with a certain pid.

Parameters:

pid -

Returns:

deleteBar

public void deleteBar(UBossBar bar)

Delete a bar.

Parameters:

bar - Delete a bar.