org.spongepowered.api.boss

Interface BossBar

All Superinterfaces:

Identifiable

All Known Subinterfaces:

ServerBossBar

public interface BossBar
extends Identifiable

Represents a boss bar.

Method Summary

Modifier and Type	Method and Description
BossBarColor	getColor() Gets the color.
Text	getName() Gets the name of this boss bar.
BossBarOverlay	getOverlay() Gets the overlay.
float	getPercent() Gets the percent.
BossBar	setColor(BossBarColor color) Sets the color.
BossBar	setCreateFog(boolean createFog) Sets if fog should be created.
BossBar	setDarkenSky(boolean darkenSky) Sets if the sky should darken.
BossBar	setName(Text name) Sets the name of this boss bar.
BossBar	setOverlay(BossBarOverlay overlay) Sets the overlay.
BossBar	setPercent(float percent) Sets the percent.
BossBar	setPlayEndBossMusic(boolean playEndBossMusic) Sets if the end boss music should be played.
boolean	shouldCreateFog() If fog should be created.
boolean	shouldDarkenSky() If the sky should darken.
boolean	shouldPlayEndBossMusic() If the end boss music should be played.

Methods inherited from interface org.spongepowered.api.util.Identifiable

getUniqueId

Method Detail

getName

Text getName()

Gets the name of this boss bar.

Returns:

The boss bar name

setName

BossBar setName(Text name)

Sets the name of this boss bar.

Parameters:

name - The boss bar name

Returns:

This boss bar

getPercent

float getPercent()

Gets the percent.

Returns:

The percent

setPercent

BossBar setPercent(float percent)

Sets the percent.

The percent must be between 0.0 and 1.0.

Parameters:

percent - The percent

Returns:

This boss bar

getColor

BossBarColor getColor()

Gets the color.

Returns:

The color of the boss bar

setColor

BossBar setColor(BossBarColor color)

Sets the color.

Parameters:

color - The color of the boss bar

Returns:

This boss bar

getOverlay

BossBarOverlay getOverlay()

Gets the overlay.

Returns:

The overlay

setOverlay

BossBar setOverlay(BossBarOverlay overlay)

Sets the overlay.

Parameters:

overlay - The overlay

Returns:

This boss bar

shouldDarkenSky

boolean shouldDarkenSky()

If the sky should darken.

Returns:

If the sky should darken

setDarkenSky

BossBar setDarkenSky(boolean darkenSky)

Sets if the sky should darken.

Parameters:

darkenSky - If the sky should darken

Returns:

This boss bar

shouldPlayEndBossMusic

boolean shouldPlayEndBossMusic()

If the end boss music should be played.

Returns:

If the end boss music should be played

setPlayEndBossMusic

BossBar setPlayEndBossMusic(boolean playEndBossMusic)

Sets if the end boss music should be played.

Parameters:

playEndBossMusic - If the end boss music should be played

Returns:

This boss bar

shouldCreateFog

boolean shouldCreateFog()

If fog should be created.

Returns:

If fog should be created

setCreateFog

BossBar setCreateFog(boolean createFog)

Sets if fog should be created.

Parameters:

createFog - If fog should be created

Returns:

This boss bar