me.croabeast.beanslib.builder

Class BossbarBuilder

java.lang.Object

me.croabeast.beanslib.builder.BossbarBuilder

public class BossbarBuilder
extends Object

This class manages how to create a BossBar instance for a player to be displayed, to set messages, color and styles. It can be animated to change messages, colors, styles and change the progress as the display time runs out.

 
 // Creating an instance of the builder
 BossbarBuilder builder = new BossbarBuilder(
      yourPlugin, player,
      Arrays.asList("My bossbar message", "It changes :D"),
      0, // if interval is 0, will be default interval
      Arrays.asList("SOLID:BLUE", "YELLOW", "SEGMENTED_10"),
      0, // if interval is 0, will be default interval
      5, // 5 is the display time in seconds
      true // if bossbar progress will decrease over time
 );

 builder.display(); // Displays the bossbar to the player.
  

Constructor Summary

Constructors

Constructor and Description
BossbarBuilder(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.configuration.ConfigurationSection section) Creates a new builder using a ConfigurationSection of a file.
BossbarBuilder(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.entity.Player player, @NotNull List<String> messages, int messageInterval, @Nullable List<String> formats, int formatInterval, int time, boolean progressDecrease) Creates a new builder with all the specified configuration.
BossbarBuilder(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull org.bukkit.entity.Player player, String string) Creates a new builder using a single line to parse all the necessary arguments.

Method Summary

Modifier and Type	Method and Description
void	display() Displays the bossbar message to the player.
static @Nullable Set<BossbarBuilder>	getBuilders(org.bukkit.entity.Player player) Gets the BeansLib bossbar object from the bossbar map.
void	unregister() Unregisters the bossbar from the player.

Methods inherited from class java.lang.Object

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

Constructor Detail

BossbarBuilder

public BossbarBuilder(@NotNull
                      @NotNull org.bukkit.plugin.Plugin plugin,
                      @NotNull
                      @NotNull org.bukkit.entity.Player player,
                      @NotNull
                      @NotNull List<String> messages,
                      int messageInterval,
                      @Nullable
                      @Nullable List<String> formats,
                      int formatInterval,
                      int time,
                      boolean progressDecrease)

Creates a new builder with all the specified configuration.

Parameters:

plugin - plugin's instance of your project

player - a player, can not be null

messages - a list of the messages to be displayed

messageInterval - custom interval of messages if 0, will use the default interval

formats - a list of BarColor and/or BarStyle of the bossbar

formatInterval - custom interval of formats if 0, will use the default interval

time - the display time of the bossbar in seconds

progressDecrease - if bossbar progress will decrease over time

BossbarBuilder

public BossbarBuilder(@NotNull
                      @NotNull org.bukkit.plugin.Plugin plugin,
                      @NotNull
                      @NotNull org.bukkit.entity.Player player,
                      @NotNull
                      @NotNull org.bukkit.configuration.ConfigurationSection section)

Creates a new builder using a ConfigurationSection of a file. Basic example: bossbars.yml

Parameters:

plugin - plugin's instance of your project

player - a player, can not be null

section - a ConfigurationSection to format the bossbar

BossbarBuilder

public BossbarBuilder(@NotNull
                      @NotNull org.bukkit.plugin.Plugin plugin,
                      @NotNull
                      @NotNull org.bukkit.entity.Player player,
                      String string)

Creates a new builder using a single line to parse all the necessary arguments. The line should be using the MessageExecutor.BOSSBAR_EXECUTOR pattern.

Parameters:

plugin - plugin's instance of your project

player - a player, can not be null

string - an input string

Method Detail

display

public void display()

Displays the bossbar message to the player.

unregister

public void unregister()

Unregisters the bossbar from the player.

getBuilders

@Nullable
public static @Nullable Set<BossbarBuilder> getBuilders(org.bukkit.entity.Player player)

Gets the BeansLib bossbar object from the bossbar map.

Parameters:

player - the player that has the bossbar.

Returns:

the bossbar, if the player exists or has a bossbar displayed; null otherwise