Facet.BossBar (adventure-platform-facet 4.2.0 API)

Type Parameters:

V - a viewer type

All Superinterfaces:

java.lang.AutoCloseable, BossBar.Listener, java.io.Closeable

All Known Subinterfaces:

Facet.BossBarEntity<V,P>, Facet.BossBarPacket<V>

Enclosing interface:

Facet<V>
```
public static interface Facet.BossBar<V>
extends BossBar.Listener, java.io.Closeable
```
A facet that listens to boss bar changes.

Since:

4.0.0

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface Facet.BossBar.Builder<V,B extends Facet.BossBar<V>>
A builder for boss bar facets.

Field Summary

Fields
Modifier and Type Field Description

static int PROTOCOL_BOSS_BAR

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`addViewer(V viewer)`	Adds a viewer to the boss bar.
`default void`	`bossBarInitialized(@NotNull BossBar bar)`	Initializes the boss bar.
`void`	`close()`	Removes all viewers.
`boolean`	`isEmpty()`	Gets whether the boss bar has no viewers.
`void`	`removeViewer(V viewer)`	Removes a viewer from the boss bar.

Methods inherited from interface net.kyori.adventure.bossbar.BossBar.Listener
bossBarColorChanged, bossBarFlagsChanged, bossBarNameChanged, bossBarOverlayChanged, bossBarPercentChanged, bossBarProgressChanged

- Field Detail
  - PROTOCOL_BOSS_BAR
```
static final int PROTOCOL_BOSS_BAR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - bossBarInitialized
```
default void bossBarInitialized(@NotNull BossBar bar)
```
    Initializes the boss bar.
    
    Parameters:
    
    bar - a boss bar
    
    Since:
    
    4.0.0
  - addViewer
```
void addViewer(@NotNull
               V viewer)
```
    Adds a viewer to the boss bar.
    
    Parameters:
    
    viewer - a viewer
    
    Since:
    
    4.0.0
  - removeViewer
```
void removeViewer(@NotNull
                  V viewer)
```
    Removes a viewer from the boss bar.
    
    Parameters:
    
    viewer - a viewer
    
    Since:
    
    4.0.0
  - isEmpty
```
boolean isEmpty()
```
    Gets whether the boss bar has no viewers.
    
    Returns:
    
    if the boss bar is empty
    
    Since:
    
    4.0.0
  - close
```
void close()
```
    Removes all viewers.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Since:
    
    4.0.0