Class Scoreboard

Remarks

Adds a new objective to the scoreboard.

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

Throws

This function can throw errors.

Example

updateScoreboard.ts

import { world, DisplaySlotId, ObjectiveSortOrder, DimensionLocation } from "@minecraft/server";

function updateScoreboard(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  const scoreboardObjectiveId = "scoreboard_demo_objective";
  const scoreboardObjectiveDisplayName = "Demo Objective";

  const players = world.getPlayers();

  // Ensure a new objective.
  let objective = world.scoreboard.getObjective(scoreboardObjectiveId);

  if (!objective) {
    objective = world.scoreboard.addObjective(scoreboardObjectiveId, scoreboardObjectiveDisplayName);
  }

  // get the scoreboard identity for player 0
  const player0Identity = players[0].scoreboardIdentity;

  if (player0Identity === undefined) {
    log("Could not get a scoreboard identity for player 0.");
    return -1;
  }

  // initialize player score to 100;
  objective.setScore(player0Identity, 100);

  world.scoreboard.setObjectiveAtDisplaySlot(DisplaySlotId.Sidebar, {
    objective: objective,
    sortOrder: ObjectiveSortOrder.Descending,
  });

  const playerScore = objective.getScore(player0Identity) ?? 0;

  // score should now be 110.
  objective.setScore(player0Identity, playerScore + 10);
}
Copy

Remarks

Clears the objective that occupies a display slot.

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

Remarks

Returns a specific objective (by id).

Remarks

Returns an objective that occupies the specified display slot.

Remarks

Returns all defined objectives.

Remarks

Returns all defined scoreboard identities.

Remarks

Removes an objective from the scoreboard.

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

Throws

This function can throw errors.

Remarks

Sets an objective into a display slot with specified additional display settings.

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

Throws

This function can throw errors.