xBossBarxBossBar

xBossBar API 🛠️

📄 Introduction

The XBossBarAPI provides static methods to interact programmatically with xBossBar. You can create, manage, and delete bossbars, add/remove players, and customize colors, styles, and titles directly from your code without instantiating the API.

🛠 Installation

Add the repository and dependency for xBossBar.

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.github.xDrygo</groupId>
    <artifactId>xBossBar</artifactId>
    <version>1.0.11</version>
    <scope>provided</scope>
</dependency>

After adding the dependency, add xBossBar as a dependency in your plugin.

name: MyPlugin
main: com.example.MyPlugin.MyPlugin
version: 1.0
depend: # depend if API is required, soft-depend if optional
  - xBossBar

📋 XBossBarAPI Methods

Click to expand

  • void createBossBar(String id, String title, BarColor color, BarStyle style, boolean perPlayer)

    Crea una nueva bossbar.
XBossBarAPI.createBossBar("gameBar", "¡Juego iniciado!", BarColor.BLUE, BarStyle.SOLID, true);

  • void removeBossBar(String id)

    Elimina una bossbar específica.
XBossBarAPI.removeBossBar("gameBar");

  • void clearAllBossBars()

    Elimina todas las bossbars.
XBossBarAPI.clearAllBossBars();

  • void addPlayerToBossBar(String id, Player player)

    Muestra la bossbar a un jugador.
XBossBarAPI.addPlayerToBossBar("gameBar", player);

  • void removePlayerFromBossBar(String id, Player player)

    Elimina la bossbar de un jugador.
XBossBarAPI.removePlayerFromBossBar("gameBar", player);

  • void setTitle(String id, String title)

    Cambia el título de la bossbar.
XBossBarAPI.setTitle("gameBar", "¡Nueva fase!");

  • void setProgress(String id, double progress)

    Cambia el progreso de la bossbar (0.0–1.0).
XBossBarAPI.setProgress("gameBar", 0.75);

  • void setStyle(String id, BarStyle style)

    Cambia el estilo de la bossbar.
XBossBarAPI.setStyle("gameBar", BarStyle.SEGMENTED_10);

  • void setColor(String id, BarColor color)

    Cambia el color de la bossbar.
XBossBarAPI.setColor("gameBar", BarColor.RED);

  • BossBar getBossBar(String id)

    Obtiene el objeto BossBar de Bukkit.
BossBar bar = XBossBarAPI.getBossBar("gameBar");

  • BossBarModel getBossBarModel(String id)

    Obtiene el objeto personalizado BossBarModel.
BossBarModel model = XBossBarAPI.getBossBarModel("gameBar");

  • Set<String> getBossBarNames()

    Devuelve todos los IDs de bossbars existentes.
Set<String> ids = XBossBarAPI.getBossBarNames();
ids.forEach(System.out::println);

💡 Notes

  • All API methods are static, so you do not need to instantiate XBossBarAPI.
  • BossBar management includes creation, deletion, player management, and customization.
  • Events allow you to react to bossbar changes in real time.

🔗 References

Previous
messages.yml
Configuration Files