Class ScoreboardObjective`Beta`

Contains objectives and participants for the scoreboard.

Index

Constructors

Properties

Methods

getParticipants getScore getScores removeParticipant setScore

Constructors

`Protected`constructor

new ScoreboardObjective(): ScoreboardObjective
Beta
Returns ScoreboardObjective

Properties

`Readonly` `Beta`displayName

displayName: string

Returns the player-visible name of this scoreboard objective.

Throws

This property can throw when used.

`Readonly` `Beta`id

id: string

Identifier of the scoreboard objective.

Throws

This property can throw when used.

Methods

getParticipants

getParticipants(): ScoreboardIdentity[]
Beta
Returns ScoreboardIdentity[]
Remarks
Returns all objective participant identities.

Throws
This function can throw errors.

getScore

getScore(participant: ScoreboardIdentity): number
Beta
Parameters
- participant: ScoreboardIdentity
  Identifier of the participant to retrieve a score for.
Returns number
Remarks
Returns a specific score for a participant.

Throws
This function can throw errors.

getScores

getScores(): ScoreboardScoreInfo[]
Beta
Returns ScoreboardScoreInfo[]
Remarks
Returns specific scores for this objective for all participants.

Throws
This function can throw errors.

removeParticipant

removeParticipant(participant: ScoreboardIdentity): boolean
Beta
Parameters
- participant: ScoreboardIdentity
  Participant to remove from being tracked with this objective.
Returns boolean
Remarks
Removes a participant from this scoreboard objective.

Throws
This function can throw errors.

setScore

setScore(participant: ScoreboardIdentity, score: number): boolean
Beta
Parameters
- participant: ScoreboardIdentity
  Identity of the participant.
- score: number
  New value of the score.
Returns boolean
Remarks
Sets a score for a participant.

Throws
This function can throw errors.