@minecraft/server
    Preparing search index...

    Class ScoreboardObjective

    Contains objectives and participants for the scoreboard.

    Index

    Properties

    displayName id

    Methods

    addScore getParticipants getScore getScores hasParticipant isValid removeParticipant setScore

    Properties

    displayName: string

    Returns the player-visible name of this scoreboard objective.

    This property can throw when used.

    id: string

    Identifier of the scoreboard objective.

    This property can throw when used.

    Methods

    • Parameters

      • participant: string | Entity | ScoreboardIdentity

        Participant to apply the scoreboard value addition to.

      • scoreToAdd: number

      Returns number

      Adds a score to the given participant and objective.

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

      This function can throw errors.

    • Returns ScoreboardIdentity[]

      Returns all objective participant identities.

      This function can throw errors.

    • Parameters

      Returns undefined | number

      Returns a specific score for a participant.

      This function can throw errors.

    • Returns ScoreboardScoreInfo[]

      Returns specific scores for this objective for all participants.

      This function can throw errors.

    • Parameters

      Returns boolean

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

      This function can throw errors.

    • Returns boolean

      This function is deprecated and will be removed in 2.0.0.

      Returns true if the ScoreboardObjective reference is still valid.

    • Parameters

      Returns boolean

      Removes a participant from this scoreboard objective.

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

      This function can throw errors.

    • Parameters

      Returns void

      Sets a score for a participant.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods