Class ScreenDisplay

Remarks

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

Throws

This function can throw errors.

Remarks

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

Throws

This function can throw errors.

Remarks

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

Throws

This function can throw errors.

Remarks

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

Throws

This function can throw errors.

Remarks

Set the action bar text - a piece of text that displays beneath the title and above the hot-bar.

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

Throws

This function can throw errors.

Remarks

Sets visibility of a particular element of the heads up display (HUD).

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

Throws

This function can throw errors.

Remarks

Will cause a title to show up on the player's on screen display. Will clear the title if set to empty string. You can optionally specify an additional subtitle as well as fade in, stay and fade out times.

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

Throws

This function can throw errors.

Example

setTitle.ts

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

function setTitle(targetLocation: DimensionLocation) {
  const players = world.getPlayers();

  if (players.length > 0) {
    players[0].onScreenDisplay.setTitle("§o§6Fancy Title§r");
  }
}
Copy

Example

setTitleAndSubtitle.ts

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

function setTitleAndSubtitle(
    targetLocation: DimensionLocation
) {
  const players = world.getPlayers();

  players[0].onScreenDisplay.setTitle("Chapter 1", {
    stayDuration: 100,
    fadeInDuration: 2,
    fadeOutDuration: 4,
    subtitle: "Trouble in Block Town",
  });
}
Copy

Example

countdown.ts

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

function countdown(targetLocation: DimensionLocation) {
  const players = world.getPlayers();

  players[0].onScreenDisplay.setTitle("Get ready!", {
    stayDuration: 220,
    fadeInDuration: 2,
    fadeOutDuration: 4,
    subtitle: "10",
  });

  let countdown = 10;

  const intervalId = system.runInterval(() => {
    countdown--;
    players[0].onScreenDisplay.updateSubtitle(countdown.toString());

    if (countdown == 0) {
      system.clearRun(intervalId);
    }
  }, 20);
}
Copy

Remarks

Updates the subtitle if the subtitle was previously displayed via the setTitle method.

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

Throws

This function can throw errors.

Example

countdown.ts

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

function countdown(targetLocation: DimensionLocation) {
  const players = world.getPlayers();

  players[0].onScreenDisplay.setTitle("Get ready!", {
    stayDuration: 220,
    fadeInDuration: 2,
    fadeOutDuration: 4,
    subtitle: "10",
  });

  let countdown = 10;

  const intervalId = system.runInterval(() => {
    countdown--;
    players[0].onScreenDisplay.updateSubtitle(countdown.toString());

    if (countdown == 0) {
      system.clearRun(intervalId);
    }
  }, 20);
}
Copy