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

    Class ScreenDisplay

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

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

    world.afterEvents.playerSpawn.subscribe((event) => {
        event.player.onScreenDisplay.setTitle('§o§6You respawned!§r');
    });

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

    world.afterEvents.playerSpawn.subscribe((event) => {
        event.player.onScreenDisplay.setTitle('You respawned', {
            stayDuration: 100,
            fadeInDuration: 2,
            fadeOutDuration: 4,
            subtitle: 'Try not to die next time!',
        });
    });

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

    world.afterEvents.playerSpawn.subscribe(event => {
        event.player.onScreenDisplay.setTitle('Get ready!', {
            stayDuration: 220,
            fadeInDuration: 2,
            fadeOutDuration: 4,
            subtitle: '10',
        });

        let countdown = 10;

        const intervalId = system.runInterval(() => {
            countdown--;
            event.player.onScreenDisplay.updateSubtitle(countdown.toString());

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

    Methods

    getHiddenHudElements hideAllExcept isForcedHidden isValid resetHudElements setActionBar setHudVisibility setTitle updateSubtitle

    Methods

    • Parameters

      Returns void

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

      This function can throw errors.

    • Parameters

      Returns boolean

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

      This function can throw errors.

    • Returns boolean

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

    • Returns void

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

      This function can throw errors.

    • Parameters

      Returns void

      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.

      This function can throw errors.

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

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

      This function can throw errors.

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

      world.afterEvents.playerSpawn.subscribe((event) => {
          event.player.onScreenDisplay.setTitle('§o§6You respawned!§r');
      });

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

      world.afterEvents.playerSpawn.subscribe((event) => {
          event.player.onScreenDisplay.setTitle('You respawned', {
              stayDuration: 100,
              fadeInDuration: 2,
              fadeOutDuration: 4,
              subtitle: 'Try not to die next time!',
          });
      });

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

      world.afterEvents.playerSpawn.subscribe(event => {
          event.player.onScreenDisplay.setTitle('Get ready!', {
              stayDuration: 220,
              fadeInDuration: 2,
              fadeOutDuration: 4,
              subtitle: '10',
          });

          let countdown = 10;

          const intervalId = system.runInterval(() => {
              countdown--;
              event.player.onScreenDisplay.updateSubtitle(countdown.toString());

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

    • Parameters

      Returns void

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

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Methods