Class ScreenDisplay`Beta`

Contains information about user interface elements that are showing up on the screen.

Index

Constructors

Methods

clearTitle setActionBar setTitle updateSubtitle

Constructors

`Protected`constructor

new ScreenDisplay(): ScreenDisplay
Beta
Returns ScreenDisplay

Methods

clearTitle

clearTitle(): void
Beta
Returns void
Remarks
Clears the title and subtitle, if currently displayed.

This function can't be called in read-only mode.

Throws
This function can throw errors.

setActionBar

setActionBar(text: string): void
Beta
Parameters
- text: string
Returns void
Remarks
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.

Throws
This function can throw errors.

setTitle

setTitle(title: string, options?: TitleDisplayOptions): void
Beta
Parameters
- title: string
- Optionaloptions: TitleDisplayOptions
Returns void
Remarks
Will cause a title to show up on the player's on screen display. 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.

Throws
This function can throw errors.

updateSubtitle

updateSubtitle(subtitle: string): void
Beta
Parameters
- subtitle: string
Returns void
Remarks
Updates the subtitle if the subtitle was previously displayed via the setTitle method.

This function can't be called in read-only mode.

Throws
This function can throw errors.