ScreenDisplay

Class in @minecraft/server

What’s on a player’s screen.

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

Example

TypeScript JavaScript

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

for (const player of world.getAllPlayers()) {
    const screenDisplay: ScreenDisplay = player.onScreenDisplay;
    console.log(player.name, screenDisplay.isValid);
}

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

for (const player of world.getAllPlayers()) {
    const screenDisplay = player.onScreenDisplay;
    console.log(player.name, screenDisplay.isValid);
}

Properties

isValid

read-only

readonly isValid: boolean;

Methods

setTitle

setTitle(title: string | RawMessage | (string | RawMessage)[], options?: TitleDisplayOptions): void;

Parameters

title

string | RawMessage | (string | RawMessage)[]

optionsoptional

TitleDisplayOptions

Types

RawMessageTitleDisplayOptions

updateSubtitle

updateSubtitle(subtitle: string | RawMessage | (string | RawMessage)[]): void;

Parameters

subtitle

string | RawMessage | (string | RawMessage)[]

Types

RawMessage

setActionBar

setActionBar(text: string | RawMessage | (string | RawMessage)[]): void;

Parameters

text

string | RawMessage | (string | RawMessage)[]

Types

RawMessage

clearTitle

clearTitle(): void;

Takes the title off the screen.

resetTitle

resetTitle(): void;

Puts the title’s times and subtitle back to the client’s own.

setHudVisibility

setHudVisibility(visible: HudVisibility, hudElements?: HudElement[]): void;

Hides HUD elements, or shows them as usual again; every element if none are named.

Parameters

visible

HudVisibility

hudElementsoptional

HudElement[]

Types

HudVisibilityHudElement

hideAllExcept

hideAllExcept(hudElements?: HudElement[]): void;

Hides every HUD element but these.

Parameters

hudElementsoptional

HudElement[]

Types

HudElement

resetHudElementsVisibility

resetHudElementsVisibility(): void;

Shows every HUD element as usual.

isForcedHidden

isForcedHidden(hudElement: HudElement): boolean;

Whether a plugin hid this element.

Parameters

hudElement

HudElement

Returns

boolean

Types

HudElement

Used by

Player.onScreenDisplay