@minecraft
    Preparing search index...

    Class ScreenDisplay

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

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

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

    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);
    }
    Index
    isValid
    getHiddenHudElements hideAllExcept isForcedHidden resetHudElementsVisibility setActionBar setHudVisibility setTitle updateSubtitle
    isValid: boolean

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

    • World mutation

      Parameters

      Returns void

      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.

      ArgumentOutOfBoundsError

      InvalidEntityError

      RawMessageError

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

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

      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);
      }
    • World mutation

      Parameters

      Returns void

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

      InvalidEntityError

      RawMessageError

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

    Settings
    Member Visibility

    On This Page
    Properties
    Methods