org.spongepowered.api.boss

Interface ServerBossBar

All Superinterfaces:

BossBar, Identifiable

public interface ServerBossBar
extends BossBar

Represents a boss bar controlled by a Server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerBossBar.Builder Represents a builder class to create mutable ServerBossBars.

Method Summary

Modifier and Type	Method and Description
ServerBossBar	addPlayer(Player player) Adds a player to this boss bar.
default ServerBossBar	addPlayers(Collection<Player> players) Adds a collection of players to this boss bar.
static ServerBossBar.Builder	builder() Creates a new ServerBossBar.Builder to create ServerBossBars.
Collection<Player>	getPlayers() Gets a collection of all players on this boss bar.
boolean	isVisible() If this boss bar is visible.
ServerBossBar	removePlayer(Player player) Removes a player from this boss bar.
default ServerBossBar	removePlayers(Collection<Player> players) Removes a collection of players from this boss bar.
ServerBossBar	setColor(BossBarColor color) Sets the color.
ServerBossBar	setCreateFog(boolean createFog) Sets if fog should be created.
ServerBossBar	setDarkenSky(boolean darkenSky) Sets if the sky should darken.
ServerBossBar	setName(Text name) Sets the name of this boss bar.
ServerBossBar	setOverlay(BossBarOverlay overlay) Sets the overlay.
ServerBossBar	setPercent(float percent) Sets the percent.
ServerBossBar	setPlayEndBossMusic(boolean playEndBossMusic) Sets if the end boss music should be played.
ServerBossBar	setVisible(boolean visible) Sets if this boss bar is visible.

Methods inherited from interface org.spongepowered.api.boss.BossBar

getColor, getName, getOverlay, getPercent, shouldCreateFog, shouldDarkenSky, shouldPlayEndBossMusic

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

getUniqueId

Method Detail

builder

static ServerBossBar.Builder builder()

Creates a new ServerBossBar.Builder to create ServerBossBars.

Returns:

The new builder

setName

ServerBossBar setName(Text name)

Description copied from interface: BossBar

Sets the name of this boss bar.

Specified by:

setName in interface BossBar

Parameters:

name - The boss bar name

Returns:

This boss bar

setPercent

ServerBossBar setPercent(float percent)

Description copied from interface: BossBar

Sets the percent.

The percent must be between 0.0 and 1.0.

Specified by:

setPercent in interface BossBar

Parameters:

percent - The percent

Returns:

This boss bar

setColor

ServerBossBar setColor(BossBarColor color)

Description copied from interface: BossBar

Sets the color.

Specified by:

setColor in interface BossBar

Parameters:

color - The color of the boss bar

Returns:

This boss bar

setOverlay

ServerBossBar setOverlay(BossBarOverlay overlay)

Description copied from interface: BossBar

Sets the overlay.

Specified by:

setOverlay in interface BossBar

Parameters:

overlay - The overlay

Returns:

This boss bar

setDarkenSky

ServerBossBar setDarkenSky(boolean darkenSky)

Description copied from interface: BossBar

Sets if the sky should darken.

Specified by:

setDarkenSky in interface BossBar

Parameters:

darkenSky - If the sky should darken

Returns:

This boss bar

setPlayEndBossMusic

ServerBossBar setPlayEndBossMusic(boolean playEndBossMusic)

Description copied from interface: BossBar

Sets if the end boss music should be played.

Specified by:

setPlayEndBossMusic in interface BossBar

Parameters:

playEndBossMusic - If the end boss music should be played

Returns:

This boss bar

setCreateFog

ServerBossBar setCreateFog(boolean createFog)

Description copied from interface: BossBar

Sets if fog should be created.

Specified by:

setCreateFog in interface BossBar

Parameters:

createFog - If fog should be created

Returns:

This boss bar

isVisible

boolean isVisible()

If this boss bar is visible.

Returns:

If this boss bar is visible

setVisible

ServerBossBar setVisible(boolean visible)

Sets if this boss bar is visible.

Parameters:

visible - If this boss bar is visible

Returns:

This boss bar

getPlayers

Collection<Player> getPlayers()

Gets a collection of all players on this boss bar.

Returns:

A collection of all players on this boss bar

addPlayer

ServerBossBar addPlayer(Player player)

Adds a player to this boss bar.

Parameters:

player - The player to add

Returns:

This boss bar

addPlayers

default ServerBossBar addPlayers(Collection<Player> players)

Adds a collection of players to this boss bar.

Parameters:

players - The players to add

Returns:

This boss bar

removePlayer

ServerBossBar removePlayer(Player player)

Removes a player from this boss bar.

Parameters:

player - The player to remove

Returns:

This boss bar

removePlayers

default ServerBossBar removePlayers(Collection<Player> players)

Removes a collection of players from this boss bar.

Parameters:

players - The players to remove

Returns:

This boss bar