Class ScreenDisplay

constructor

• new ScreenDisplay(player: Player): ScreenDisplay

  Create a new screen display for the player.

  Parameters

  • player: Player

    The player that the screen display is for.

  Returns ScreenDisplay

ReadonlyhiddenElements

clearTitle

• clearTitle(): void

  Clear the title of the player.

  Returns void

hideAllElements

• hideAllElements(): void

  Hide all elements from the screen display.

  Returns void

hideElement

• hideElement(...elements: HudElement[]): void

  Hide a specific element from the screen display.

  Parameters

  • ...elements: HudElement[]

  Returns void

setActionBar

• setActionBar(text: string, options?: TitleDisplayOptions): void

  Set the action bar of the player.

  Parameters

  • text: string

    The text to display.
  • Optionaloptions: TitleDisplayOptions

    The additional options for the action bar.

  Returns void

setJukeboxPopup

• setJukeboxPopup(text: string): void

  Set the jukebox popup of the player.

  Parameters

  • text: string

    The text to display.

  Returns void

setTitle

• setTitle(text: string, options?: TitleDisplayOptions): void

  Set the title of the player.

  Parameters

  • text: string

    The text to display.
  • Optionaloptions: TitleDisplayOptions

    The additional options for the title.

  Returns void

setToast

• setToast(title: string, text: string): void

  Set the toast of the player;

  Parameters

  • title: string

    The title of the toast.
  • text: string

  Returns void

setToolTip

• setToolTip(text: string): void

  Set the tooltip text of the player.

  Parameters

  • text: string

    The text to display.

  Returns void

showAllElements

• showAllElements(): void

  Show all elements from the screen display.

  Returns void

showElement

• showElement(...elements: HudElement[]): void

  Show a specific element from the screen display.

  Parameters

  • ...elements: HudElement[]

  Returns void

updateSubtitle

• updateSubtitle(text: string, options?: TitleDisplayOptions): void

  Update the subtitle for the title of the player.

  Parameters

  • text: string

    The text to display.
  • Optionaloptions: TitleDisplayOptions

    The additional options for the subtitle.

  Returns void