@minecraft/server-editor
    Preparing search index...

    Interface IRootPropertyPaneBeta

    A root pane that can store property items.

    interface IRootPropertyPane {
        collapsed: boolean;
        id: string;
        onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
        visible: boolean;
        addBlockList(
            value: IObservableProp<string[]>,
            options?: IBlockListPropertyItemOptions,
        ): IBlockListPropertyItem;
        addBlockTable(
            options?: IBlockTablePropertyItemOptions,
        ): IBlockTablePropertyItem;
        addBool(
            value: IObservableProp<boolean>,
            options?: IBoolPropertyItemOptions,
        ): IBoolPropertyItem;
        addButton(
            action: ButtonPropertyItemSupportedActionTypes,
            options?: IButtonPropertyItemOptions,
        ): IButtonPropertyItem;
        addButtonPane(
            options?: IButtonPanePropertyItemOptions,
        ): IButtonPanePropertyItem;
        addColorPicker(
            value: IObservableProp<RGBA>,
            options?: IColorPickerPropertyItemOptions,
        ): IColorPickerPropertyItem;
        addColorTimeline(
            value: IObservableProp<number>,
            options?: IColorTimelinePropertyItemOptions,
        ): IColorTimelinePropertyItem;
        addComboBox(
            value: IObservableProp<string>,
            options?: IComboBoxPropertyItemOptions,
        ): IComboBoxPropertyItem;
        addDataTable(
            options?: IDataTablePropertyItemOptions,
        ): IDataTablePropertyItem;
        addDivider(): IPropertyItemBase;
        addDropdown(
            value: IObservableProp<number>,
            options?: IDropdownPropertyItemOptions,
        ): IDropdownPropertyItem;
        addImage(
            value: IObservableProp<string | ImageResourceData>,
            options?: IImagePropertyItemOptions,
        ): IImagePropertyItem;
        addLink(
            value: IObservableProp<string>,
            options?: ILinkPropertyItemOptions,
        ): ILinkPropertyItem;
        addListPane(options: IListPanePropertyItemOptions): IListPanePropertyItem;
        addMenu(
            defaultEntries: {
                action?: RegisteredAction<NoArgsAction>;
                params: IMenuCreationParams;
            }[],
            options?: IMenuPropertyItemOptions,
        ): IMenuPropertyItem;
        addNumber(
            value: IObservableProp<number>,
            options?: INumberPropertyItemOptions,
        ): INumberPropertyItem;
        addNumberTimeline(
            value: IObservableProp<number>,
            options?: INumberTimelinePropertyItemOptions,
        ): INumberTimelinePropertyItem;
        addProgressIndicator(
            options?: IProgressIndicatorPropertyItemOptions,
        ): IProgressIndicatorPropertyItem;
        addProxyPane(paneId: string): void;
        addString(
            value: IObservableProp<string>,
            options?: IStringPropertyItemOptions,
        ): IStringPropertyItem;
        addText(
            value: IObservableProp<LocalizedString>,
            options?: ITextPropertyItemOptions,
        ): ITextPropertyItem;
        addToggleGroup(
            value: IObservableProp<number>,
            options?: IToggleGroupPropertyItemOptions,
        ): IToggleGroupPropertyItem;
        addVector2(
            value: IObservableProp<Vector2>,
            options?: IVector2PropertyItemOptions,
        ): IVector2PropertyItem;
        addVector3(
            value: IObservableProp<Vector3>,
            options?: IVector3PropertyItemOptions,
        ): IVector3PropertyItem;
        beginConstruct(): void;
        collapse(): void;
        createModalOverlayPane(
            options?: IModalOverlayPaneOptions,
        ): IModalOverlayPane;
        createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
        endConstruct(): void;
        expand(): void;
        getActiveModalOverlayId(): undefined | string;
        getTitle(): undefined | LocalizedString;
        hide(): void;
        isHeaderActionVisible(): boolean;
        removeSubPane(paneToRemove: IPropertyPane): boolean;
        setActiveModalOverlay(id: undefined | string): void;
        setHeaderActionVisibility(visible: boolean): void;
        setTitle(newTitle: undefined | LocalizedString): void;
        show(): void;
        toggleSubPaneVisibility(subPaneId: undefined | string): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    collapsed id onPropertyPaneVisibilityUpdated visible

    Methods

    addBlockList addBlockTable addBool addButton addButtonPane addColorPicker addColorTimeline addComboBox addDataTable addDivider addDropdown addImage addLink addListPane addMenu addNumber addNumberTimeline addProgressIndicator addProxyPane addString addText addToggleGroup addVector2 addVector3 beginConstruct collapse createModalOverlayPane createSubPane endConstruct expand getActiveModalOverlayId getTitle hide isHeaderActionVisible removeSubPane setActiveModalOverlay setHeaderActionVisibility setTitle show toggleSubPaneVisibility

    Properties

    collapsed: boolean

    Pane state for being expanded or collapsed.

    id: string

    Unique identifier for the pane.

    onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>

    Provides visibility change events

    visible: boolean

    Check visibility of the pane

    Methods

    • Beta

      Parameters

      • paneId: string

      Returns void

      Adds a proxy view of another supported pane

    • Beta

      Returns void

      Begins pane construction for batching property item additions

    • Beta

      Returns void

      Collapse the pane.

    • Beta

      Parameters

      Returns IModalOverlayPane

      Register a modal overlay to the root pane. It will be hidden by default, when shown it will display over the root pane content. Only one modal overlay can be shown at a time.

    • Beta

      Returns void

      Finalizes pane construction and synchronizes item data

    • Beta

      Returns void

      Expand the pane.

    • Beta

      Returns undefined | string

      Unique identifier of the active modal overlay

    • Beta

      Returns void

      Hide the pane.

    • Beta

      Returns boolean

      Current visibility state of header action

    • Beta

      Parameters

      • id: undefined | string

        Unique id for modal overlay pane.

      Returns void

      Sets registered modal overlay as active, if not found it will hide the current.

    • Beta

      Parameters

      • visible: boolean

        New visibility state of the action button.

      Returns void

      If a header action exists, updates visibility of the button.

    • Beta

      Returns void

      Show the pane and all of its items.

    • Beta

      Parameters

      • subPaneId: undefined | string

        Identifier of the sub pane to display.

      Returns void

      Shows only the specified sub-pane, hiding all others

    Settings

    Member Visibility

    On This Page

    Properties
    Methods