For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/interfaces/BuiltInUIManager.md.

Interface: BuiltInUIManager

Beta

Represents a UI session for a given player

Methods

activateTutorial()

activateTutorial(): void

Beta

Returns

void

Remarks

Activates tutorial overlay


navigateToDocumentation(): void

Beta

Returns

void

Remarks

Navigates to the documentation site.


navigateToFeedback(): void

Beta

Returns

void

Remarks

Navigates to the feedback site


navigateToPauseScreen(): void

Beta

Returns

void

Remarks

Navigates to the pause screen


navigateToSamples(): void

Beta

Returns

void

Remarks

Navigates to the github-samples site


saveAndExit()

saveAndExit(): void

Beta

Returns

void

Remarks

Saves levels & exits back to Editor main menu.


showKeyboardSettings()

showKeyboardSettings(): void

Beta

Returns

void

Remarks

Shows the Keyboard Settings modal


showUpdateInformation()

showUpdateInformation(): void

Beta

Returns

void

Remarks

Shows update information for the current version


updateControlHelpPanelVisibility()

updateControlHelpPanelVisibility(visibility): void

Beta

Parameters

visibility

boolean

Returns

void

Remarks

Updates the visibility of the Control Help panel


updateLogPanelVisibility()

updateLogPanelVisibility(visibility): void

Beta

Parameters

visibility

boolean

Returns

void

Remarks

Updates the visibility of the log panel


updateStructurePanelVisibility()

updateStructurePanelVisibility(visibility): void

Beta

Parameters

visibility

boolean

Returns

void

Remarks

Updates the visibility of the Structure panel


updateUISettingsPanelVisibility()

updateUISettingsPanelVisibility(visibility): void

Beta

Parameters

visibility

boolean

Returns

void

Remarks

Updates the visibility of the control demo