Private
constructorThis function can't be called in read-only mode.
This function can throw errors.
Optional
hudElements: HudElement[]Optional
This function can't be called in read-only mode.
This function can throw errors.
This function can't be called in read-only mode.
This function can throw errors.
New value for the action bar text.
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.
// Script by WavePlayz
import { world } from "@minecraft/server";
// Subscribe to the event that triggers when a player places a block
world.afterEvents.playerPlaceBlock.subscribe((eventData) => {
// Extract the player and block objects from the event data
const { player, block } = eventData;
// Display a message on the player's action bar indicating the type of block they placed
player.onScreenDisplay.setActionBar(`You placed ${block.typeId}`);
});
Whether to set the HUD element to invisible, or to reset it back to its default.
Optional
hudElements: HudElement[]Optional list of HUD elements to configure visibility for.
Optional
Sets visibility of a particular element of the heads up display (HUD).
This function can't be called in read-only mode.
This function can throw errors.
Optional
options: TitleDisplayOptionsOptional
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);
});
// Script by WavePlayz
import { world } from "@minecraft/server";
// Function to convert seconds to ticks (1 second = 20 ticks in Minecraft)
let secsToTicks = (secs) => secs * 20;
// Subscribe to the event that triggers when a player places a block
world.afterEvents.playerPlaceBlock.subscribe((eventData) => {
// Extract the player and block objects from the event data
const { player, block } = eventData;
// Define display options for the title message
let displayOptions = {
fadeInDuration: secsToTicks(0.5), // Duration for the title to fade in
fadeOutDuration: secsToTicks(1), // Duration for the title to fade out
stayDuration: secsToTicks(1.5), // Duration for the title to stay on screen
subtitle: player.name, // Subtitle showing the player's name
};
// Set the title message to display when a block is placed
player.onScreenDisplay.setTitle(
`You placed \n ${block.typeId}`,
displayOptions
);
});
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.
Contains information about user interface elements that are showing up on the screen.
Example
setTitle.ts
Example
setTitleAndSubtitle.ts
Example
titleCountdown.ts