Private
constructorReadonly
isReturns true if the current reference to this screen display manager object is valid and functional.
This property can't be read in early-execution mode.
This function can't be called in read-only mode.
This function can't be called in early-execution mode.
Optional
hudElements: HudElement[]This function can't be called in read-only mode.
This function can't be called in early-execution mode.
This function can't be called in read-only mode.
This function can't be called in early-execution mode.
This function can't be called in read-only mode.
This function can't be called in early-execution mode.
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't be called in early-execution mode.
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.
This function can't be called in read-only mode.
This function can't be called in early-execution mode.
Optional
options: TitleDisplayOptionsWill 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.
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);
}
This function can't be called in early-execution mode.
import { world } from "@minecraft/server";
// Function to convert seconds to ticks (1 second = 20 ticks in Minecraft)
let secsToTicks = (/** @type {number} */ 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);
});
This function can't be called in read-only mode.
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);
}
This function can't be called in early-execution mode.
Contains information about user interface elements that are showing up on the screen.
Example: setTitle.ts
Example: setTitleAndSubtitle.ts
Example: countdown.ts