BossBarHelper
com.jsmacrosce.jsmacros.client.api.helper.world.entity.BossBarHelper
A wrapper exposing the state of one boss bar known to the client.
World.getBossBars() returns a map keyed by the string from getUUID().
The boss-bar event's bossBar field is null when a bar is removed.
The percentage is the smoothed one the overlay animates towards rather than the value the server last sent: the bar eases from the previous percentage to the new one over 100 milliseconds, so reads can differ even when the server has sent nothing in between.
js
const bars = World.getBossBars();
Chat.log(`${bars.size()} boss bar(s) on screen`);
for (const entry of bars.entrySet()) {
const bar = entry.getValue();
// the percentage is a fraction from 0 to 1, not a number from 0 to 100
const percent = Math.round(bar.getPercent() * 100);
Chat.log(`${bar.getName().getString()} at ${percent}% (${bar.getColor()}, ${bar.getStyle()})`);
}Constructors
new BossBarHelper
Methods
getColor
Returns the BossEvent.BossBarColor enum name in uppercase, so one of
PINK, BLUE, RED, GREEN, YELLOW, PURPLE or WHITE. These are the seven the game defines, and the string is what the TypeScript typings narrow this to. This name does not uniquely identify the formatting: PINK and RED both use red formatting. Use getColorFormat() or getColorValue() for the formatting or its RGB value.Returns: the uppercase enum name.
getColorFormat
Returns the formatting associated with the bar's color.
Returns: the bar color's formatting.
getColorValue
Returns the packed RGB value of the bar's formatting, or
-1 if it has no RGB value.Returns: the formatting's RGB value, or
-1 if absent.getName
Returns the bar's title as a TextHelper, preserving its text styling.
Returns: the bar's styled title.
getPercent
Returns the current smoothed progress as a fraction from
0 to 1. The client animates this value toward the latest progress received from the server.Returns: current progress fraction; values are not converted to percentages.
getStyle
Returns the BossEvent.BossBarOverlay enum name in uppercase, so one of
PROGRESS, NOTCHED_6, NOTCHED_10, NOTCHED_12 or NOTCHED_20. The notched ones are the same bar with the notches added, and the number is how many segments it is cut into.Returns: the uppercase overlay enum name.