Class Scoreboard

Index

Constructors

Properties

objectives slots world

Methods

addObjective clearObjectiveAtDisplaySlot getObjective getObjectiveAtDisplaySlot removeObjective setObjectiveAtDisplaySlot

Constructors

constructor

new Scoreboard(world: World): Scoreboard
Creates a new scoreboard.
Parameters
- world: World
  The world the scoreboard will be binded to.
Returns Scoreboard
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:34

Properties

`Readonly`objectives

objectives: Set<ScoreboardObjective> = ...

The objectives of the scoreboard.

`Readonly`slots

slots: Map<DisplaySlotType, ScoreboardObjective> = ...

The current objectives in the display slots.

`Protected` `Readonly`world

world: World

The world the scoreboard is binded to.

Methods

addObjective

addObjective(name: string, display?: string): ScoreboardObjective
Adds a new objective to the scoreboard.
Parameters
- name: string
  The name of the objective.
- Optionaldisplay: string
  The display name of the objective.
Returns ScoreboardObjective
The objective that was added.
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:60

clearObjectiveAtDisplaySlot

clearObjectiveAtDisplaySlot(
slot: DisplaySlotType,
options?: ScoreboardObjectiveDisplayOptions,
): undefined | ScoreboardObjective
Clears the objective at the display slot.
Parameters
- slot: DisplaySlotType
  The display slot to clear the objective at.
- Optionaloptions: ScoreboardObjectiveDisplayOptions
  The options to clear the objective with.
Returns undefined | ScoreboardObjective
The objective that was cleared.
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:158

getObjective

getObjective(name: string): undefined | ScoreboardObjective
Gets the objective with the specified name.
Parameters
- name: string
  The name of the objective.
Returns undefined | ScoreboardObjective
The objective with the specified name, or undefined if no objective was found.
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:43

getObjectiveAtDisplaySlot

getObjectiveAtDisplaySlot(
slot: DisplaySlotType,
): undefined | ScoreboardObjective
Gets the objective at the display slot.
Parameters
- slot: DisplaySlotType
  The display slot to get the objective at.
Returns undefined | ScoreboardObjective
The objective at the display slot, or undefined if no objective was found.
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:100

removeObjective

removeObjective(objective: string | ScoreboardObjective): void
Removes the objective from the scoreboard.
Parameters
- objective: string | ScoreboardObjective
  The objective to remove.
Returns void
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:79

setObjectiveAtDisplaySlot

setObjectiveAtDisplaySlot(
slot: DisplaySlotType,
options: ScoreboardObjectiveDisplayOptions,
): ScoreboardObjective
Sets the objective at the display slot.
Parameters
- slot: DisplaySlotType
  The display slot to set the objective at.
- options: ScoreboardObjectiveDisplayOptions
  The options to set the objective with.
Returns ScoreboardObjective
The objective that was set.
- Defined in packages/core/src/world/scoreboard/scoreboard.ts:112