Class ScreenDisplay

Remarks

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

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

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 } from '@minecraft/server';

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

Example

setTitleAndSubtitle.ts

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

Example

titleCountdown.ts

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