Class ScreenDisplayBeta

Contains information about user interface elements that are showing up on the screen.

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");
  }
}

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",
  });
}

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);
}

Constructors

constructor

Properties

isValid

Methods

getHiddenHudElements hideAllExcept isForcedHidden resetHudElements setActionBar setHudVisibility setTitle updateSubtitle

Constructors

Privateconstructor

Properties

Readonly BetaisValid

isValid: boolean

Remarks

Returns true if the current reference to this screen display manager object is valid and functional.

Methods

getHiddenHudElements

hideAllExcept

isForcedHidden

resetHudElements

setActionBar

setHudVisibility

setTitle

  • setTitle(
        title: string | RawMessage | (string | RawMessage)[],
        options?: TitleDisplayOptions,
    ): void
    Beta

    Parameters

    Returns void

    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");
      }
    }

    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",
      });
    }

    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);
    }

updateSubtitle

Settings

Member Visibility

On This Page

Constructors
Properties
Methods