Add scale health display API. Adds BUKKIT-4432

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot 2013-07-03 01:15:53 -05:00
parent 153cde6043
commit cd6af522b1

View file

@ -23,6 +23,7 @@ import org.bukkit.scoreboard.Scoreboard;
* Represents a player, connected or not
*/
public interface Player extends HumanEntity, Conversable, CommandSender, OfflinePlayer, PluginMessageRecipient {
/**
* Gets the "friendly" name to display of this player. This may include color.
* <p>
@ -646,4 +647,24 @@ public interface Player extends HumanEntity, Conversable, CommandSender, Offline
* yet or has logged out
*/
public void setScoreboard(Scoreboard scoreboard) throws IllegalArgumentException, IllegalStateException;
/**
* Gets if the client is displayed a 'scaled' health, that is, health on a
* scale from 0-20.
*
* @return if client health display is scaled
* @see Player#setScaledHealth(boolean)
*/
public boolean isScaledHealth();
/**
* Sets if the client is displayed a 'scaled' health, that is, health on a
* scale from 0-20.
* <p>
* Displayed health follows a simple formula <code>displayedHealth =
* getHealth() / getMaxHealth() * 20.0D</code>.
*
* @param scale if the client health display is scaled
*/
public void setScaleHealth(boolean scale);
}