Skip to main content

Type alias: IPlayerUISession<PerPlayerStorage>

IPlayerUISession<PerPlayerStorage>: object

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

Type parameterValue
PerPlayerStorageRecord<string, never>

Type declaration

actionManager

readonly actionManager: ActionManager

builtInUIManager

readonly builtInUIManager: BuiltInUIManager

eventSubscriptionCache

readonly eventSubscriptionCache: BedrockEventSubscriptionCache

extensionContext

readonly extensionContext: ExtensionContext

inputManager

readonly inputManager: IGlobalInputManager

log

readonly log: IPlayerLogger

readonly menuBar: IMenuContainer

scratchStorage

scratchStorage: PerPlayerStorage | undefined

toolRail

readonly toolRail: IModalToolContainer

createPropertyPane()

Parameters

ParameterType
optionsIPropertyPaneOptions

Returns

IPropertyPane

createStatusBarItem()

Parameters

ParameterType
alignmentEditorStatusBarAlignment
sizenumber

Returns

IStatusBarItem