Class ScoreboardObjectiveBeta

Readonly displayName

Readonly id

getParticipants

• getParticipants(): ScoreboardIdentity[]

• Returns ScoreboardIdentity[]

  Remarks

  Returns all objective participant identities.

  Throws

  This function can throw errors.

getScore

• getScore(participant): undefined | number

• Parameters

  • participant: string | Entity | ScoreboardIdentity

    Identifier of the participant to retrieve a score for.

  Returns undefined | number

  Remarks

  Returns a specific score for a participant.

  Throws

  This function can throw errors.

getScores

• getScores(): ScoreboardScoreInfo[]

• Returns ScoreboardScoreInfo[]

  Remarks

  Returns specific scores for this objective for all participants.

  Throws

  This function can throw errors.

hasParticipant

• hasParticipant(participant): boolean

• Parameters

  • participant: string | Entity | ScoreboardIdentity

  Returns boolean

  Remarks

  Returns if the specified identity is a participant of the scoreboard objective.

  Throws

  This function can throw errors.

isValid

• isValid(): boolean

• Returns boolean

removeParticipant

• removeParticipant(participant): boolean

• Parameters

  • participant: string | Entity | ScoreboardIdentity

    Participant to remove from being tracked with this objective.

  Returns boolean

  Remarks

  Removes a participant from this scoreboard objective.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

setScore

• setScore(participant, score): void

• Parameters

  • participant: string | Entity | ScoreboardIdentity

    Identity of the participant.

  • score: number

    New value of the score.

  Returns void

  Remarks

  Sets a score for a participant.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.