org.spongepowered.api.boss

Interface ServerBossBar.Builder

All Superinterfaces:

ResettableBuilder<ServerBossBar,ServerBossBar.Builder>

Enclosing interface:

ServerBossBar

public static interface ServerBossBar.Builder
extends ResettableBuilder<ServerBossBar,ServerBossBar.Builder>

Represents a builder class to create mutable ServerBossBars.

See Also:

BossBar, ServerBossBar

Method Summary

Modifier and Type	Method and Description
ServerBossBar	build() Build the boss bar from the values in this builder.
ServerBossBar.Builder	color(BossBarColor color) Sets the color.
ServerBossBar.Builder	createFog(boolean createFog) Sets if fog should be created.
ServerBossBar.Builder	darkenSky(boolean darkenSky) Sets if the sky should darken.
ServerBossBar.Builder	name(Text name) Sets the name of the boss bar.
ServerBossBar.Builder	overlay(BossBarOverlay overlay) Sets the overlay.
ServerBossBar.Builder	percent(float percent) Sets the percent.
ServerBossBar.Builder	playEndBossMusic(boolean playEndBossMusic) Sets if the end boss music should be played.
ServerBossBar.Builder	visible(boolean visible) Sets if the boss bar is visible.

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

from, reset

Method Detail

name

ServerBossBar.Builder name(Text name)

Sets the name of the boss bar.

Parameters:

name - The boss bar name

Returns:

This builder

percent

ServerBossBar.Builder percent(float percent)

Sets the percent.

The percent must be between 0.0 and 1.0.

Parameters:

percent - The percent

Returns:

This builder

color

ServerBossBar.Builder color(BossBarColor color)

Sets the color.

Parameters:

color - The color

Returns:

This builder

overlay

ServerBossBar.Builder overlay(BossBarOverlay overlay)

Sets the overlay.

Parameters:

overlay - The overlay

Returns:

This builder

darkenSky

ServerBossBar.Builder darkenSky(boolean darkenSky)

Sets if the sky should darken.

Parameters:

darkenSky - If the sky should darken

Returns:

This builder

playEndBossMusic

ServerBossBar.Builder playEndBossMusic(boolean playEndBossMusic)

Sets if the end boss music should be played.

Parameters:

playEndBossMusic - If the end boss music should be played

Returns:

This builder

createFog

ServerBossBar.Builder createFog(boolean createFog)

Sets if fog should be created.

Parameters:

createFog - If fog should be created

Returns:

This builder

visible

ServerBossBar.Builder visible(boolean visible)

Sets if the boss bar is visible.

Parameters:

visible - If this boss bar is visible

Returns:

This builder

build

ServerBossBar build()

Build the boss bar from the values in this builder.

Returns:

The boss bar