Script API - v1.21.110
    Preparing search index...

    Class ScoreboardObjective

    Contains objectives and participants for the scoreboard.

    Index

    Constructors

    constructor

    Properties

    displayName id isValid

    Methods

    addScore getParticipants getScore getScores hasParticipant removeParticipant setScore

    Constructors

    Properties

    displayName: string

    Returns the player-visible name of this scoreboard objective.

    This property can throw when used.

    This property can't be read in early-execution mode.

    id: string

    Identifier of the scoreboard objective.

    This property can throw when used.

    This property can't be read in early-execution mode.

    isValid: boolean

    Returns true if the ScoreboardObjective reference is still valid.

    This property can't be read in early-execution mode.

    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.

      This function can't be called in early-execution mode.

      import { world } from "@minecraft/server";

      const money = world.scoreboard.getObjective("money");
      const player = world.getPlayers()[0];
      const currentScore = money.addScore(player, 100);
      player.sendMessage(`Your current score is ${currentScore}`);

      import { world } from "@minecraft/server";

      const money = world.scoreboard.getObjective("money");
      const player = world.getPlayers()[0];
      const currentScore = money.addScore(player, -100);
      player.sendMessage(`Your current score is ${currentScore}`);

    • Parameters

      Returns number

      Returns a specific score for a participant.

      This function can throw errors.

      This function can't be called in early-execution mode.

    • Returns ScoreboardScoreInfo[]

      Returns specific scores for this objective for all participants.

      This function can throw errors.

      This function can't be called in early-execution mode.

      import { world } from "@minecraft/server";

      const money = world.scoreboard.getObjective("money");
      var scoreArray = money.getScores();
      scoreArray.sort(function (a, b) {
          return b.score - a.score;
      });

      console.log(scoreArray.map((score) => score.participant.displayName));

    • 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.

      This function can't be called in early-execution mode.

    • Parameters

      Returns void

      Sets a score for a participant.

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

      This function can throw errors.

      This function can't be called in early-execution mode.

      import { world } from "@minecraft/server";

      const money = world.scoreboard.getObjective("money");
      const player = world.getPlayers()[0];
      money.setScore(player, 0);
      player.sendMessage(`Your score has been reset.`);

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods