endstone.scoreboard

Classes relating to manage the client side score display system.

Classes

Name	Description
`Criteria`	Represents a scoreboard criteria.
`DisplaySlot`	Locations for displaying objectives to the player
`Objective`	Represents an objective on a scoreboard that can show scores specific to entries.
`ObjectiveSortOrder`	Represents the sort order of objectives on a DisplaySlot.
`RenderType`	Controls the way in which an Objective is rendered on the client side.
`Score`	Represents a score for an objective on a scoreboard.
`Scoreboard`	Represents a scoreboard

`class`Criteria

Criteria()

Represents a scoreboard criteria.

Classes

Name	Description
`Type`	Represents a scoreboard criteria.

Attributes

Name	Type	Description
`DUMMY`		The dummy criteria. Not changed by the server.
`default_render_type`	`RenderType`
`is_read_only`	`bool`
`name`	`str`

`attr`DUMMY

DUMMY

The dummy criteria. Not changed by the server.

`attr`default_render_typeproperty

default_render_type: RenderType

`attr`is_read_onlyproperty

is_read_only: bool

`attr`nameproperty

name: str

`class`Type

Bases: Enum

Type()

Represents a scoreboard criteria.

Attributes

Name	Type	Description
`DUMMY`		The dummy criteria. Not changed by the server.

`attr`DUMMY

DUMMY = 0

The dummy criteria. Not changed by the server.

`class`DisplaySlot

Bases: Enum

DisplaySlot()

Locations for displaying objectives to the player

Attributes

Name	Type	Description
`BELOW_NAME`		Displays the score below the player's name.
`PLAYER_LIST`		Displays the score in the player list on the pause screen.
`SIDE_BAR`		Displays the score on the side of the player's screen.

`attr`BELOW_NAME

BELOW_NAME = 0

Displays the score below the player's name.

`attr`PLAYER_LIST

PLAYER_LIST = 1

Displays the score in the player list on the pause screen.

`attr`SIDE_BAR

SIDE_BAR = 2

Displays the score on the side of the player's screen.

`class`Objective

Objective()

Represents an objective on a scoreboard that can show scores specific to entries.

Methods

Name	Description
`get_score`	Gets an entry's Score for this objective
`set_display`	Sets the display slot and sort order for this objective. This will remove it from any other display slot.
`unregister`	Unregisters this objective from the associated Scoreboard.

Attributes

Name	Type	Description
`criteria`	`Criteria`	Gets the criteria this objective tracks
`display_name`	`str`	Gets or sets the name displayed to players for this objective
`display_slot`	`DisplaySlot \| None`	Gets or sets the display slot this objective is displayed at
`is_displayed`	`bool`	Gets if the objective is currently displayed in a slot.
`is_modifiable`	`bool`	Gets if the objective's scores can be modified directly by a plugin
`name`	`str`	Gets the name of this Objective
`render_type`	`RenderType`	Gets the manner in which this objective will be rendered.
`scoreboard`	`Scoreboard`	Gets the scoreboard to which this objective is attached
`sort_order`	`ObjectiveSortOrder \| None`	Gets or sets the sort order for this objective

`attr`criteriaproperty

criteria: Criteria

Gets the criteria this objective tracks

`attr`display_nameproperty

display_name: str

Gets or sets the name displayed to players for this objective

`attr`display_slotproperty

display_slot: DisplaySlot | None

Gets or sets the display slot this objective is displayed at

`attr`is_displayedproperty

is_displayed: bool

Gets if the objective is currently displayed in a slot.

`attr`is_modifiableproperty

is_modifiable: bool

Gets if the objective's scores can be modified directly by a plugin

`attr`nameproperty

name: str

Gets the name of this Objective

`attr`render_typeproperty

render_type: RenderType

Gets the manner in which this objective will be rendered.

`attr`scoreboardproperty

scoreboard: Scoreboard

Gets the scoreboard to which this objective is attached

`attr`sort_orderproperty

sort_order: ObjectiveSortOrder | None

Gets or sets the sort order for this objective

`meth`get_score

get_score(entry: Player | Actor | str) -> Score

Gets an entry's Score for this objective

`meth`set_display

set_display(slot: DisplaySlot | None, order: ObjectiveSortOrder = ObjectiveSortOrder.ASCENDING) -> None

Sets the display slot and sort order for this objective. This will remove it from any other display slot.

`meth`unregister

unregister() -> None

Unregisters this objective from the associated Scoreboard.

`class`ObjectiveSortOrder

Bases: Enum

ObjectiveSortOrder()

Represents the sort order of objectives on a DisplaySlot.

Attributes

Name	Type	Description
`ASCENDING`		Sorts the objectives in the ascending order
`DESCENDING`		Sorts the objectives in the descending order

`attr`ASCENDING

ASCENDING = 0

Sorts the objectives in the ascending order

`attr`DESCENDING

DESCENDING = 1

Sorts the objectives in the descending order

`class`RenderType

Bases: Enum

RenderType()

Controls the way in which an Objective is rendered on the client side.

Attributes

Name	Type	Description
`HEARTS`
`INTEGER`

`attr`HEARTS

HEARTS = 1

`attr`INTEGER

INTEGER = 0

`class`Score

Score()

Represents a score for an objective on a scoreboard.

Attributes

Name	Type	Description
`entry`	`Player \| Actor \| str`	Gets the entry being tracked by this Score
`is_score_set`	`bool`	Shows if this score has been set at any point in time.
`objective`	`Objective`	Gets the Objective being tracked by this Score.
`scoreboard`	`Scoreboard`	Gets the scoreboard for the associated objective.
`value`	`int`	Gets or sets the current score.

`attr`entryproperty

entry: Player | Actor | str

Gets the entry being tracked by this Score

`attr`is_score_setproperty

is_score_set: bool

Shows if this score has been set at any point in time.

`attr`objectiveproperty

objective: Objective

Gets the Objective being tracked by this Score.

`attr`scoreboardproperty

scoreboard: Scoreboard

Gets the scoreboard for the associated objective.

`attr`valueproperty

value: int

Gets or sets the current score.

`class`Scoreboard

Scoreboard()

Represents a scoreboard

Methods

Name	Description
`add_objective`	Registers an Objective on this Scoreboard with a name displayed to players
`clear_slot`	Clears any objective in the specified slot
`get_objectives_by_criteria`	Gets all Objectives of a Criteria on the Scoreboard
`get_scores`	Gets all scores for an entry on this Scoreboard
`reset_scores`	Removes all scores for an entry on this Scoreboard

Attributes

Name	Type	Description
`entries`	`list[Player \| Actor \| str]`	Gets all entries tracked by this Scoreboard
`objectives`	`list[Objective]`	Gets all Objectives on this Scoreboard

`attr`entriesproperty

entries: list[Player | Actor | str]

Gets all entries tracked by this Scoreboard

`attr`objectivesproperty

objectives: list[Objective]

Gets all Objectives on this Scoreboard

`meth`add_objective

add_objective(name: str, criteria: Type, display_name: str | None = None, render_type: RenderType = RenderType.INTEGER) -> Objective

Registers an Objective on this Scoreboard with a name displayed to players

`meth`clear_slot

clear_slot(slot: DisplaySlot) -> None

Clears any objective in the specified slot

`meth`get_objectives_by_criteria

get_objectives_by_criteria(criteria: Type) -> list[Objective]

Gets all Objectives of a Criteria on the Scoreboard

`meth`get_scores

get_scores(entry: Player | Actor | str) -> list[Score]

Gets all scores for an entry on this Scoreboard

`meth`reset_scores

reset_scores(entry: Player | Actor | str) -> None

Removes all scores for an entry on this Scoreboard

endstone.scoreboard

classCriteria

attrDUMMY

attrdefault_render_typeproperty

attris_read_onlyproperty

attrnameproperty

classType

attrDUMMY

classDisplaySlot

attrBELOW_NAME

attrPLAYER_LIST

attrSIDE_BAR

classObjective

attrcriteriaproperty

attrdisplay_nameproperty

attrdisplay_slotproperty

attris_displayedproperty

attris_modifiableproperty

attrnameproperty

attrrender_typeproperty

attrscoreboardproperty

attrsort_orderproperty

methget_score

methset_display

methunregister

classObjectiveSortOrder

attrASCENDING

attrDESCENDING

classRenderType

attrHEARTS

attrINTEGER

classScore

attrentryproperty

attris_score_setproperty

attrobjectiveproperty

attrscoreboardproperty

attrvalueproperty

classScoreboard

attrentriesproperty

attrobjectivesproperty

methadd_objective

methclear_slot

methget_objectives_by_criteria

methget_scores

methreset_scores

On this page

`class`Criteria

`attr`DUMMY

`attr`default_render_typeproperty

`attr`is_read_onlyproperty

`attr`nameproperty

`class`Type

`attr`DUMMY

`class`DisplaySlot

`attr`BELOW_NAME

`attr`PLAYER_LIST

`attr`SIDE_BAR

`class`Objective

`attr`criteriaproperty

`attr`display_nameproperty

`attr`display_slotproperty

`attr`is_displayedproperty

`attr`is_modifiableproperty

`attr`nameproperty

`attr`render_typeproperty

`attr`scoreboardproperty

`attr`sort_orderproperty

`meth`get_score

`meth`set_display

`meth`unregister

`class`ObjectiveSortOrder

`attr`ASCENDING

`attr`DESCENDING

`class`RenderType

`attr`HEARTS

`attr`INTEGER

`class`Score

`attr`entryproperty

`attr`is_score_setproperty

`attr`objectiveproperty

`attr`scoreboardproperty

`attr`valueproperty

`class`Scoreboard

`attr`entriesproperty

`attr`objectivesproperty

`meth`add_objective

`meth`clear_slot

`meth`get_objectives_by_criteria

`meth`get_scores

`meth`reset_scores