twin/paper-mc
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-08-03 21:52:05 -07:00
Code Issues Packages Projects Releases Wiki Activity

Add API to manipulate boss bar of entities and those created by commands

Browse Source 
By: Yannick Lamprecht <yannicklamprecht@live.de>
This commit is contained in:
Bukkit/Spigot
2018-11-10 20:22:05 +11:00
parent 905e0f7cac
commit 4782571b82
6 changed files with 169 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
paper-api/src/main/java/org/bukkit/Server.java
View File

@@ -19,6 +19,7 @@ import org.bukkit.boss.BarColor;
import org.bukkit.boss.BarFlag;
import org.bukkit.boss.BarStyle;
import org.bukkit.boss.BossBar;
import org.bukkit.boss.KeyedBossBar;
import org.bukkit.command.CommandException;
import org.bukkit.command.CommandSender;
import org.bukkit.command.ConsoleCommandSender;
@@ -986,6 +987,72 @@ public interface Server extends PluginMessageRecipient {
*/
BossBar createBossBar(String title, BarColor color, BarStyle style, BarFlag... flags);
/**
* Creates a boss bar instance to display to players. The progress defaults
* to 1.0.
* <br>
* This instance is added to the persistent storage of the server and will
* be editable by commands and restored after restart.
*
* @param key the key of the boss bar that is used to access the boss bar
* @param title the title of the boss bar
* @param color the color of the boss bar
* @param style the style of the boss bar
* @param flags an optional list of flags to set on the boss bar
* @return the created boss bar
*/
KeyedBossBar createBossBar(NamespacedKey key, String title, BarColor color, BarStyle style, BarFlag... flags);
/**
* Gets an unmodifiable iterator through all persistent bossbars.
* <ul>
* <li><b>not</b> bound to a {@link org.bukkit.entity.Boss}</li>
* <li>
* <b>not</b> created using
* {@link #createBossBar(String, BarColor, BarStyle, BarFlag...)}
* </li>
* </ul>
*
* e.g. bossbars created using the bossbar command
*
* @return a bossbar iterator
*/
Iterator<KeyedBossBar> getBossBars();
/**
* Gets the {@link KeyedBossBar} specified by this key.
* <ul>
* <li><b>not</b> bound to a {@link org.bukkit.entity.Boss}</li>
* <li>
* <b>not</b> created using
* {@link #createBossBar(String, BarColor, BarStyle, BarFlag...)}
* </li>
* </ul>
*
* e.g. bossbars created using the bossbar command
*
* @param key unique bossbar key
* @return bossbar or null if not exists
*/
KeyedBossBar getBossBar(NamespacedKey key);
/**
* Removes a {@link KeyedBossBar} specified by this key.
* <ul>
* <li><b>not</b> bound to a {@link org.bukkit.entity.Boss}</li>
* <li>
* <b>not</b> created using
* {@link #createBossBar(String, BarColor, BarStyle, BarFlag...)}
* </li>
* </ul>
*
* e.g. bossbars created using the bossbar command
*
* @param key unique bossbar key
* @return true if removal succeeded or false
*/
boolean removeBossBar(NamespacedKey key);
/**
* Gets an entity on the server by its UUID
*