Skip to Content
⚠ Under Construction
ReferencePython APIendstone.boss

endstone.boss

Classes:

NameDescription
BarColor
BarFlag
BarStyle
BossBarRepresents a boss bar that is displayed to players.

BarColor

BarColor(value:int)

Attributes:

BLUE

BLUE: BarColor

GREEN

GREEN: BarColor

PINK

PINK: BarColor

PURPLE

PURPLE: BarColor

REBECCA_PURPLE

REBECCA_PURPLE: BarColor

RED

RED: BarColor

WHITE

WHITE: BarColor

YELLOW

YELLOW: BarColor

name

name: str

value

value: int

BarFlag

BarFlag(value:int)

Attributes:

DARKEN_SKY

DARKEN_SKY: BarFlag

name

name: str

value

value: int

BarStyle

BarStyle(value:int)

Attributes:

SEGMENTED_10

SEGMENTED_10: BarStyle

SEGMENTED_12

SEGMENTED_12: BarStyle

SEGMENTED_20

SEGMENTED_20: BarStyle

SEGMENTED_6

SEGMENTED_6: BarStyle

SOLID

SOLID: BarStyle

name

name: str

value

value: int

BossBar

Represents a boss bar that is displayed to players.

Methods:

NameDescription
add_flagAdds an optional flag to this boss bar.
add_playerAdds the player to this boss bar causing it to display on their screen.
has_flagChecks whether this boss bar has the passed flag set.
remove_allRemoves all players from this boss bar.
remove_flagRemoves an existing flag on this boss bar.
remove_playerRemoves the player from this boss bar causing it to be removed from their screen.

Attributes:

NameTypeDescription
colorBarColorThe color of this boss bar.
is_visibleboolIf the boss bar is displayed to attached players.
playerslist[Player]Returns all players viewing this boss bar.
progressfloatThe progress of the bar between 0.0 and 1.0.
styleBarStyleThe style of this boss bar.
titlestrThe title of this boss bar.

color

color: BarColor

The color of this boss bar.

is_visible

is_visible: bool

If the boss bar is displayed to attached players.

players

players: list[Player]

Returns all players viewing this boss bar.

progress

progress: float

The progress of the bar between 0.0 and 1.0.

style

style: BarStyle

The style of this boss bar.

title

title: str

The title of this boss bar.

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.

Last updated on