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/types/IPlayerUISession.md.

Type Alias: IPlayerUISession<PerPlayerStorage>

IPlayerUISession<PerPlayerStorage> = object

Beta

The IPlayerUISession represents the editor user interface for a given player and given extension. Extensions registered with Minecraft are instantiated for each player which joins a server, and this interface provides the set of functionality needed to create and modify the editor UI for that player. The associated Editor Context for this session object is also player specific. From a given IPlayerUISession object, there is no way to interact with the UI of another player, that must be done from global extension scope registration and/or data sharing independent of the UI object.

Type Parameters

PerPlayerStorage

PerPlayerStorage = Record<string, never>

Properties

actionBar

readonly actionBar: IActionBar


actionManager

readonly actionManager: ActionManager


badgeManager

readonly badgeManager: IContentBadgeManager


builtInUIManager

readonly builtInUIManager: BuiltInUIManager


dialogManager

readonly dialogManager: IModalDialogManager


eventSubscriptionCache

readonly eventSubscriptionCache: BedrockEventSubscriptionCache


extensionContext

readonly extensionContext: ExtensionContext


inputManager

readonly inputManager: IGlobalInputManager


log

readonly log: IPlayerLogger


readonly menuBar: IMenuContainer


paneManager

readonly paneManager: IPaneManager


scratchStorage

scratchStorage: PerPlayerStorage | undefined


statusBar

readonly statusBar: IStatusBar


toolRail

readonly toolRail: IModalToolContainer

Methods

createPropertyPane()

createPropertyPane(options): IRootPropertyPane

Parameters

options

IRootPropertyPaneOptions

Returns

IRootPropertyPane