ScreenDisplay Class
Contains information about user interface elements that are showing up on the screen.
Examples
setTitle.ts
import { world } from '@minecraft/server';
world.afterEvents.playerSpawn.subscribe((event) => {
event.player.onScreenDisplay.setTitle('§o§6You respawned!§r');
});
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!',
});
});
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);
});
Methods
getHiddenHudElements
getHiddenHudElements(): HudElement[]
Returns HudElement[]
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
hideAllExcept
hideAllExcept(hudElements?: HudElement[]): void
Parameters
- hudElements?: HudElement[] =
null
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
isForcedHidden
isForcedHidden(hudElement: HudElement): boolean
Parameters
- hudElement: HudElement
Returns boolean
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
isValid
isValid(): boolean
Returns true if the current reference to this screen display manager object is valid and functional.
Returns boolean
resetHudElements
resetHudElements(): void
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
setActionBar
setActionBar(text: (RawMessage | string)[] | RawMessage | string): void
Set the action bar text - a piece of text that displays beneath the title and above the hot-bar.
Parameters
text: (RawMessage | string)[] | RawMessage | string
New value for the action bar text.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
setHudVisibility
setHudVisibility(visible: HudVisibility, hudElements?: HudElement[]): void
Sets visibility of a particular element of the heads up display (HUD).
Parameters
visible: HudVisibility
Whether to set the HUD element to invisible, or to reset it back to its default.
hudElements?: HudElement[] =
null
Optional list of HUD elements to configure visibility for.
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
setTitle
setTitle(title: (RawMessage | string)[] | RawMessage | string, options?: TitleDisplayOptions): 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.
Parameters
- title: (RawMessage | string)[] | RawMessage | string
- options?: TitleDisplayOptions =
null
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
Examples
setTitle.ts
import { world } from '@minecraft/server';
world.afterEvents.playerSpawn.subscribe((event) => {
event.player.onScreenDisplay.setTitle('§o§6You respawned!§r');
});
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!',
});
});
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);
});
updateSubtitle
updateSubtitle(subtitle: (RawMessage | string)[] | RawMessage | string): void
Updates the subtitle if the subtitle was previously displayed via the setTitle method.
Parameters
- subtitle: (RawMessage | string)[] | RawMessage | string
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
Examples
setTitle.ts
import { world } from '@minecraft/server';
world.afterEvents.playerSpawn.subscribe((event) => {
event.player.onScreenDisplay.setTitle('§o§6You respawned!§r');
});
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!',
});
});
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);
});
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for