Class ScoreboardObjective

constructor

• new ScoreboardObjective(
      world: World,
      objectiveName: string,
      displayName?: string,
  ): ScoreboardObjective

  Parameters

  • world: World
  • objectiveName: string
  • OptionaldisplayName: string

  Returns ScoreboardObjective

displayName

ReadonlyobjectiveName

Readonlyparticipants

addParticipant

• addParticipant(
      participant: string | Entity | ScoreboardIdentity,
      initialScore?: number,
  ): ScoreboardIdentity

  Adds a participant to the objective.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity of the participant to add.
  • initialScore: number = 0

    The initial score of the participant.

  Returns ScoreboardIdentity

addScore

• addScore(
      participant: string | Entity | ScoreboardIdentity,
      score: number,
  ): number

  Adds a score to the participant in the objective.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity of the participant.
  • score: number

    The score to add.

  Returns number

  The new score of the participant.

clearScores

• clearScores(): void

  Clears the scores of all the participants in the objective.

  Returns void

getParticipant

• getParticipant(
      participant: string | Entity | ScoreboardIdentity,
  ): null | ScoreboardIdentity

  Gets the specified identity from the objective.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity to get.

  Returns null | ScoreboardIdentity

  The identity if found, undefined otherwise.

getParticipants

• getParticipants(): ScoreboardIdentity[]

  Get all the participants in the objective.

  Returns ScoreboardIdentity[]

getScore

• getScore(participant: string | Entity | ScoreboardIdentity): null | number

  Gets the score of the participant in the objective.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity of the participant.

  Returns null | number

  The score of the participant, null if the participant is not in the objective.

hasParticipant

• hasParticipant(participant: string | Entity | ScoreboardIdentity): boolean

  Checks if the specified identity is a participant in the objective.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity to check.

  Returns boolean

  True if the identity is a participant in the objective, false otherwise.

removeParticipant

• removeParticipant(participant: string | Entity | ScoreboardIdentity): boolean

  Removes a participant from the objective using the specified identity.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity of the participant to remove.

  Returns boolean

  True if the participant was removed, false otherwise.

setScore

• setScore(participant: string | Entity | ScoreboardIdentity, score: number): void

  Sets the score of the participant in the objective.

  Parameters

  • participant: string | Entity | ScoreboardIdentity

    The identity of the participant.
  • score: number

    The new score of the participant.

  Returns void