Boss

endstone.boss

Classes:

Name	Description
BarColor
BarFlag
BarStyle
BossBar	Represents a boss bar that is displayed to players.

BarColor

BarColor(value: int)

Attributes:

Name	Type	Description
BLUE	BarColor
GREEN	BarColor
PINK	BarColor
PURPLE	BarColor
REBECCA_PURPLE	BarColor
RED	BarColor
WHITE	BarColor
YELLOW	BarColor
name	str
value	int

BLUE class-attribute

BLUE: BarColor

GREEN class-attribute

GREEN: BarColor

PINK class-attribute

PINK: BarColor

PURPLE class-attribute

PURPLE: BarColor

REBECCA_PURPLE class-attribute

REBECCA_PURPLE: BarColor

RED class-attribute

RED: BarColor

WHITE class-attribute

WHITE: BarColor

YELLOW class-attribute

YELLOW: BarColor

name property

name: str

value property

value: int

BarFlag

BarFlag(value: int)

Attributes:

Name	Type	Description
DARKEN_SKY	BarFlag
name	str
value	int

DARKEN_SKY class-attribute

DARKEN_SKY: BarFlag

name property

name: str

value property

value: int

BarStyle

BarStyle(value: int)

Attributes:

Name	Type	Description
SEGMENTED_10	BarStyle
SEGMENTED_12	BarStyle
SEGMENTED_20	BarStyle
SEGMENTED_6	BarStyle
SOLID	BarStyle
name	str
value	int

SEGMENTED_10 class-attribute

SEGMENTED_10: BarStyle

SEGMENTED_12 class-attribute

SEGMENTED_12: BarStyle

SEGMENTED_20 class-attribute

SEGMENTED_20: BarStyle

SEGMENTED_6 class-attribute

SEGMENTED_6: BarStyle

SOLID class-attribute

SOLID: BarStyle

name property

name: str

value property

value: int

BossBar

Represents a boss bar that is displayed to players.

Methods:

Name	Description
add_flag	Adds an optional flag to this boss bar.
add_player	Adds the player to this boss bar causing it to display on their screen.
has_flag	Checks whether this boss bar has the passed flag set.
remove_all	Removes all players from this boss bar.
remove_flag	Removes an existing flag on this boss bar.
remove_player	Removes the player from this boss bar causing it to be removed from their screen.

Attributes:

Name	Type	Description
color	BarColor	The color of this boss bar.
players	list[Player]	Returns all players viewing this boss bar.
progress	float	The progress of the bar between 0.0 and 1.0.
style	BarStyle	The style of this boss bar.
title	str	The title of this boss bar.
visible	bool	If the boss bar is displayed to attached players.

color property writable

color: BarColor

The color of this boss bar.

players property

players: list[Player]

Returns all players viewing this boss bar.

progress property writable

progress: float

The progress of the bar between 0.0 and 1.0.

style property writable

style: BarStyle

The style of this boss bar.

title property writable

title: str

The title of this boss bar.

visible property writable

visible: bool

If the boss bar is displayed to attached players.

add_flag

add_flag(flag: BarFlag) -> None

Adds an optional flag to this boss bar.

add_player

add_player(player: Player) -> None

Adds the player to this boss bar causing it to display on their screen.

has_flag

has_flag(flag: BarFlag) -> bool

Checks whether this boss bar has the passed flag set.

remove_all

remove_all() -> None

Removes all players from this boss bar.

remove_flag

remove_flag(flag: BarFlag) -> None

Removes an existing flag on this boss bar.

remove_player

remove_player(player: Player) -> None

Removes the player from this boss bar causing it to be removed from their screen.