类 ScreenDisplay实验性

只读 实验性isValid

getHiddenHudElements

• getHiddenHudElements(): HudElement[]
• 实验性

  返回 HudElement[]

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

hideAllExcept

• hideAllExcept(hudElements?: HudElement[]): void
• 实验性

  参数

  • 可选hudElements: HudElement[]

  返回 void

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

isForcedHidden

• isForcedHidden(hudElement: HudElement): boolean
• 实验性

  参数

  • hudElement: HudElement

  返回 boolean

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

resetHudElements

• resetHudElements(): void
• 实验性

  返回 void

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

setActionBar

• setActionBar(text: string | RawMessage | (string | RawMessage)[]): void
• 实验性

  参数

  • text: string | RawMessage | (string | RawMessage)[]

    New value for the action bar text.

  返回 void

  备注

  Set the action bar text - a piece of text that displays beneath the title and above the hot-bar.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

setHudVisibility

• setHudVisibility(visible: HudVisibility, hudElements?: HudElement[]): void
• 实验性

  参数

  • visible: HudVisibility

    Whether to set the HUD element to invisible, or to reset it back to its default.
  • 可选hudElements: HudElement[]

    Optional list of HUD elements to configure visibility for.

  返回 void

  备注

  Sets visibility of a particular element of the heads up display (HUD).

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

setTitle

• setTitle(
      title: string | RawMessage | (string | RawMessage)[],
      options?: TitleDisplayOptions,
  ): void
• 实验性

  参数

  • title: string | RawMessage | (string | RawMessage)[]
  • 可选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.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  示例: setTitle.ts

  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");
    }
  }
  复制

  示例: setTitleAndSubtitle.ts

  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",
    });
  }
  复制

  示例: countdown.ts

  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);
  }
  复制

updateSubtitle

• updateSubtitle(subtitle: string | RawMessage | (string | RawMessage)[]): void
• 实验性

  参数

  • subtitle: string | RawMessage | (string | RawMessage)[]

  返回 void

  备注

  Updates the subtitle if the subtitle was previously displayed via the setTitle method.

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  示例: countdown.ts

  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);
  }
  复制