BarAPI

BarAPI

Server Owners

This plugin does nothing on its own. It is simply an API for other plugins to implement with.

Developers

Simply add BarAPI.jar to your project build path.

This plugin makes use of reflection and therefore "shouldn't" break on craftbukkit updates.

Limitations

The message can not be more than 64 characters. If it is more, BarAPI will automatically cut it to 64 characters to prevent the client from crashing.

This is a client limitation and cannot be changed.

Examples

BarAPI.setMessage(Player player, String message)

Set a message for the player. It will remain there until the player logs off or another plugin overrides it.

BarAPI.setMessage(Player player, String message, float percent)

Same as above except you can set the % of the health bar. 100 shows the entire health bar, 50 shows half the health bar and so on.

BarAPI.setMessage(final Player player, String message, int seconds)

Sets a timed message for the player. It will remain until the timer runs out. The health automatically reduces based on how long the timer is.

BarAPI.hasBar(Player player)

Pretty self explanatory, returns a boolean.

BarAPI.removeBar(Player player)

Also pretty self explanatory.

BarAPI.setHealth(Player player, float percent)

Allows you to modify the health of an existing bar. If the player has no bar, this does nothing.

Tutorials

German - DerFeliix

Source

GitHub

Maven

<repositories>
	<repository>
		<id>confuser-repo</id>
		<url>http://ci.frostcast.net/plugin/repository/everything</url>
	</repository>
</repositories>

<dependencies>
	<dependency>
		<groupId>me.confuser</groupId>
		<artifactId>BarAPI</artifactId>
		<version>3.0</version>
	</dependency>
</dependencies>

Updater

This plugin contains an auto updater which is enabled by default. If you do not wish to automatically download new updates, edit BarAPI/config.yml and set autoUpdate to false.

To Dos

  • Scroll messages if string is greater than 64 characters.

Plugins Using BarAPI

WelcomeBar

Parkour

QuickSupport

BossBroadcast

BossMessage

PvPGames Automated

BossEventScheduler

Infernal Mobs

MythicMobs

MultiKill

PlayerBoss

BossAds

Item Lore Stats

BossBarPro

VIPLobby

Metrics

To determine popularity and usage of BarAPI, plugin installs are automatically tracked by the Metrics plugin tracking system. Your Java version, OS, player count, server country location and plugin & server versions are collected. This is used to determine what environments are using the plugin to ensure full compatibility. This collection is anonymous. If you don't want this tracking, edit plugins/PluginMetrics/config.yml and set opt-out to true.

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of Splated Splated Apr 18, 2014 at 17:02 UTC - 0 likes

    RemoveBar appears to be broken.

    	Player[] p = Bukkit.getServer().getOnlinePlayers();
    for(Player player:p){
    				
            BarAPI.removeBar(player);
    }
    

    Edit: Error seems to be caused after /reload logging out fixes it.

    Last edited Apr 18, 2014 by Splated

    BFAK:Splated,90570372,ff4e1caf1df3f2db74014bc7fdad5b2365d86e09b4a2a218ee8bc959e3ca6aa4

    http://dev.bukkit.org/media/images/46/606/SOLARAPOCALYPSE_copy.png

  • Avatar of thibautdt thibautdt Apr 18, 2014 at 15:37 UTC - 0 likes

    where can i download it i am making a new server that is going to be awesome but i dont now how to download it here and instal it to the server

  • Avatar of xGh0sTkiLLeRx xGh0sTkiLLeRx Apr 17, 2014 at 17:43 UTC - 0 likes

    Psst, you might want to add SilkSpawners to the list of the plugins.
    Will be included in the next release :)

    Want to have a dropbox acc with 500MB more space? Contact me!

    Server | Twitter | Github

    Donations are very appreciated!
    http://goo.gl/tXb7G

  • Avatar of NathanTheDragon NathanTheDragon Apr 15, 2014 at 13:42 UTC - 0 likes

    As you've probably hear, Mojang changed their Username system to the UUID system. Will you support this?

    Thanks, ~ Nathan

  • Avatar of unenergizer unenergizer Apr 11, 2014 at 07:35 UTC - 0 likes

    Thank you, it works great! Really easy to use and implement!

    BFAK:21416,fa3158e4e71a444711f1a9cfeba179d2df2963bd7e1437b35ea64c3d3c620c78

  • Avatar of TheMystake TheMystake Apr 10, 2014 at 08:13 UTC - 0 likes

    Just wanted to say thanks for making it open source!

  • Avatar of ftbastler ftbastler Apr 05, 2014 at 14:12 UTC - 0 likes

    Really cool! BukkitGames uses it.

    The BukkitGames plugin has moved. You can now find it in the Spigot forums.

  • Avatar of austinv11 austinv11 Apr 03, 2014 at 20:47 UTC - 0 likes

    Hey, not sure if this is possible, but could you make it so that instead of requiring a Player, you could use a Location

    BFAK:90939722,0c3743d3481e28bf02eb376d7f5da063eb8ff9cfa16d6332bee3cec0ec4a4bdd Check out my plugins!

    LootPlus, EnhancedSpawners

  • Avatar of Blue_Blaze72 Blue_Blaze72 Mar 29, 2014 at 06:51 UTC - 0 likes

    Hello, great API! Very useful and simple to put in! =) I have one small suggestion however. When utilizing your setMessage(player, message, seconds) to count down to the time a given event would occur, I found that there's no way to make the bar start somewhere in the middle. Perhaps this functionality wouldn't have an obvious use at first, so let me paint my scenario.

    I have a bar that counts down until a boss mob respawns, however I don't want this bar to show server wide, only in the world of the boss. Therefore, as players enter and leave the world, I add and remove the bar as necessary. HOWEVER, when a player enters the world, there's no way to show that the bar is X percent done AND have it continue to count down.

    Therefore I propose you add a new method signature setMessage(player, message, seconds, percent) that would be almost exactly the same as the above except that the initial dragon health would be based on the percent rather than defaulting to full health.

    To keep from breaking other plugins, you can keep the old method signature and have it call the new one with a percent at 100.0f, thus retaining the old functionality. Looking at the code, this should be a pretty simple change, and I would make the change myself to add to your github but I can't seem to remember my github login credentials. If I manage to get on github I will make the changes and add it as a new issue.

    Thanks for taking the time to consider my suggestion! =)

  • Avatar of darkness1999 darkness1999 Mar 26, 2014 at 15:53 UTC - 0 likes

    @uyghti123: Go

    I would like that too.

    BFAK:90850870,218e1d7422d341c847e4fa6fcd13f975c8c5a19f889d216026b99d12e0e72bd5

Facts

Date created
Sep 01, 2013
Category
Last update
Apr 19, 2014
Development stage
Release
License
Creative Commons Attribution-NonCommercial-ShareAlike 2.0 UK: England & Wales
Curse link
BarAPI
Downloads
115,302
Recent files

Authors