@minecraft/server-editor 0.1.0-beta.1.21.70-preview.21 → 0.1.0-beta.1.21.70-preview.23

package/index.d.ts

@@ -95,6 +95,14 @@ export declare enum ComboBoxPropertyItemDataType {
     Entity = 2,
 }
 
+export enum ContiguousSelectionType {
+    SameBlock = 0,
+    SameBlockAndStates = 1,
+    SolidBlocks = 2,
+    AllBlocks = 3,
+    Custom = 4,
+}
+
 /**
  * Execution state of the continuous action
  */
@@ -1019,6 +1027,7 @@ export declare enum PropertyItemType {
     BlockTable = 'editorUI:BlockTable',
     Boolean = 'editorUI:Boolean',
     Button = 'editorUI:Button',
+    ButtonPane = 'editorUI:ButtonPane',
     ColorPicker = 'editorUI:ColorPicker',
     ComboBox = 'editorUI:ComboBox',
     Divider = 'editorUI:Divider',
@@ -1172,6 +1181,11 @@ export type ActivationFunctionType<PerPlayerStorageType> = (
     uiSession: IPlayerUISession<PerPlayerStorageType>,
 ) => IDisposable[];
 
+/**
+ * All possible button item action types
+ */
+export type ButtonPropertyItemSupportedActionTypes = (() => void) | RegisteredAction<NoArgsAction>;
+
 /**
  * An action that continues to execute after activation
  */
@@ -1614,6 +1628,31 @@ export class BlockUtilities {
         volume: minecraftserver.BlockVolumeBase | minecraftserver.CompoundBlockVolume | Selection,
         block?: minecraftserver.BlockPermutation | minecraftserver.BlockType | string,
     ): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.Error}
+     */
+    getContiguousSelection(properties?: ContiguousSelectionProperties): minecraftserver.CompoundBlockVolume;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.Error}
+     */
+    getFacePreviewSelection(properties?: QuickExtrudeProperties): minecraftserver.ListBlockVolume;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    quickExtrude(properties?: QuickExtrudeProperties): void;
 }
 
 export class BrushShapeManager {
@@ -4187,6 +4226,17 @@ export interface ClipboardWriteOptions {
     rotation?: minecraftserver.StructureRotation;
 }
 
+export interface ContiguousSelectionProperties {
+    checkForAdjacentFace?: boolean;
+    contiguousSelectionBlockList?: string[];
+    contiguousSelectionType?: ContiguousSelectionType;
+    fullSelectionToleranceLevel?: number;
+    isFace?: boolean;
+    selectionDirection?: number;
+    size?: number;
+    startingLocation?: minecraftserver.Vector3;
+}
+
 export interface CursorPosition {
     FaceDirection: number;
     Position: minecraftserver.Vector3;
@@ -4650,6 +4700,36 @@ export interface IBoolPropertyItemOptions extends IPropertyItemOptionsBase {
     variant?: BoolPropertyItemVariant;
 }
 
+/**
+ * A property item pane which supports multiple buttons
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IButtonPanePropertyItem extends IPropertyItemBase, IPane {
+    /**
+     * @remarks
+     * Adds a button to the pane and binds the specified action to
+     * the button interaction.
+     *
+     */
+    addButton(
+        action: ButtonPropertyItemSupportedActionTypes,
+        options?: IButtonPropertyItemOptions,
+    ): IButtonPropertyItem;
+}
+
+/**
+ * Optional properties for Button Pane property item
+ */
+export interface IButtonPanePropertyItemOptions {
+    /**
+     * @remarks
+     * Minimum width for each item within the layout. If undefined,
+     * it will default to 6.
+     *
+     */
+    itemMinWidth?: number;
+}
+
 /**
  * A property item which supports Button properties
  */
@@ -5280,6 +5360,72 @@ export interface IMenuCreationParams {
     uniqueId?: string;
 }
 
+/**
+ * A sub pane for modal control elements.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IModalControlPane extends IPane {
+    /**
+     * @remarks
+     * Adds a togglable boolean item to the pane.
+     *
+     */
+    addBool(value: IObservableProp<boolean>, options?: IBoolPropertyItemOptions): IBoolPropertyItem;
+    /**
+     * @remarks
+     * Adds a button to the pane and binds the specified action to
+     * the button activation.
+     *
+     */
+    addButton(
+        action: ButtonPropertyItemSupportedActionTypes,
+        options?: IButtonPropertyItemOptions,
+    ): IButtonPropertyItem;
+    /**
+     * @remarks
+     * Adds a pane for grouped button layout.
+     *
+     */
+    addButtonPane(options?: IButtonPanePropertyItemOptions): IButtonPanePropertyItem;
+    /**
+     * @remarks
+     * Adds an divider item to the pane.
+     *
+     */
+    addDivider(): IPropertyItemBase;
+}
+
+/**
+ * A modal overlay pane is displayed over a root pane.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IModalOverlayPane extends IPane {
+    /**
+     * @remarks
+     * A sub pane that represents content of the modal overlay.
+     *
+     */
+    contentPane: ISubPanePropertyItem;
+    /**
+     * @remarks
+     * A pane that represent modal control elements.
+     *
+     */
+    controlPane: IModalControlPane;
+}
+
+/**
+ * The options to create a modal overlay pane.
+ */
+export interface IModalOverlayPaneOptions {
+    /**
+     * @remarks
+     * Localized title of the modal overlay.
+     *
+     */
+    title?: LocalizedString;
+}
+
 export interface IModalTool {
     /**
      * @remarks
@@ -5442,6 +5588,36 @@ export interface IObservable<T> {
     set(newValue: T): boolean;
 }
 
+/**
+ * Pane represents a container for UI components.
+ */
+export interface IPane {
+    /**
+     * @remarks
+     * Unique identifier for the pane.
+     *
+     */
+    readonly id: string;
+    /**
+     * @remarks
+     * Check visibility of the pane
+     *
+     */
+    visible: boolean;
+    /**
+     * @remarks
+     * Hide the pane.
+     *
+     */
+    hide(): void;
+    /**
+     * @remarks
+     * Show the pane and all of its items.
+     *
+     */
+    show(): void;
+}
+
 /**
  * Log helper interface for Player.
  */
@@ -5781,31 +5957,20 @@ export interface IPropertyItemOptionsVector3 extends IPropertyItemOptions {
  * with an object and presented with different kind of
  * controls.
  */
-export interface IPropertyPane {
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IPropertyPane extends IPane {
     /**
      * @remarks
      * Pane state for being expanded or collapsed.
      *
      */
     collapsed: boolean;
-    /**
-     * @remarks
-     * Unique ID for the property pane.
-     *
-     */
-    readonly id: string;
     /**
      * @remarks
      * Provides visibility change events
      *
      */
     onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
-    /**
-     * @remarks
-     * Check visibility of the pane
-     *
-     */
-    visible: boolean;
     /**
      * @remarks
      * Adds a block list to the pane.
@@ -5825,6 +5990,8 @@ export interface IPropertyPane {
     addBlockTable(options?: IBlockTablePropertyItemOptions): IBlockTablePropertyItem;
     /**
      * @remarks
+     * Adds a togglable boolean item to the pane.
+     *
      */
     addBool(value: IObservableProp<boolean>, options?: IBoolPropertyItemOptions): IBoolPropertyItem;
     /**
@@ -5840,13 +6007,19 @@ export interface IPropertyPane {
     /**
      * @remarks
      * Adds a button to the pane and binds the specified action to
-     * the button activate.
+     * the button interaction.
      *
      */
     addButton(
-        action: (() => void) | RegisteredAction<NoArgsAction>,
+        action: ButtonPropertyItemSupportedActionTypes,
         options?: IButtonPropertyItemOptions,
     ): IButtonPropertyItem;
+    /**
+     * @remarks
+     * Adds a pane for grouped button layout.
+     *
+     */
+    addButtonPane(options?: IButtonPanePropertyItemOptions): IButtonPanePropertyItem;
     /**
      * @remarks
      * Adds a color picker item to the pane.
@@ -5910,7 +6083,7 @@ export interface IPropertyPane {
     ): IImagePropertyItem;
     /**
      * @remarks
-     * Adds a multiline Text item to the pane.
+     * Adds a Link item to the pane.
      *
      */
     addLink(value: IObservableProp<string>, options?: ILinkPropertyItemOptions): ILinkPropertyItem;
@@ -5938,6 +6111,8 @@ export interface IPropertyPane {
     addProgressIndicator(options?: IProgressIndicatorPropertyItemOptions): IProgressIndicatorPropertyItem;
     /**
      * @remarks
+     * Adds an editable string item to the pane
+     *
      */
     addString(value: IObservableProp<string>, options?: IStringPropertyItemOptions): IStringPropertyItem;
     /**
@@ -6006,22 +6181,10 @@ export interface IPropertyPane {
     createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
     /**
      * @remarks
-     * Expand the pane.
-     *
-     */
-    expand(): void;
-    /**
-     * @remarks
-     * Returns property pane title.
+     * Returns pane title.
      *
      */
     getTitle(): LocalizedString | undefined;
-    /**
-     * @remarks
-     * Hide the pane.
-     *
-     */
-    hide(): void;
     /**
      * @remarks
      * Removes an existing sub pane.
@@ -6030,18 +6193,12 @@ export interface IPropertyPane {
     removeSubPane(paneToRemove: IPropertyPane): boolean;
     /**
      * @remarks
-     * Updates title of property pane.
+     * Updates title of pane.
      *
      * @param newTitle
      * New title
      */
     setTitle(newTitle: LocalizedString | undefined): void;
-    /**
-     * @remarks
-     * Show the pane and all of its property items.
-     *
-     */
-    show(): void;
 }
 
 /**
@@ -6123,12 +6280,37 @@ export interface IRegisterExtensionOptionalParameters {
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IRootPropertyPane extends IPropertyPane {
+    /**
+     * @remarks
+     * 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.
+     *
+     * @param options
+     * Creation parameters for modal overlay pane.
+     */
+    createModalOverlayPane(options?: IModalOverlayPaneOptions): IModalOverlayPane;
+    /**
+     * @remarks
+     * @returns
+     * Unique identifier of the active modal overlay
+     */
+    getActiveModalOverlayId(): string | undefined;
     /**
      * @remarks
      * @returns
      * Current visibility state of header action
      */
     isHeaderActionVisible(): boolean;
+    /**
+     * @remarks
+     * Sets registered modal overlay as active, if not found it
+     * will hide the current.
+     *
+     * @param id
+     * Unique id for modal overlay pane.
+     */
+    setActiveModalOverlay(id: string | undefined): void;
     /**
      * @remarks
      * If a header action exists, updates visibility of the button.
@@ -7217,6 +7399,17 @@ export interface ProjectExportOptions {
     initialTimOfDay?: number;
 }
 
+export interface QuickExtrudeProperties {
+    checkForAdjacentFace?: boolean;
+    contiguousSelectionBlockList?: string[];
+    contiguousSelectionType?: ContiguousSelectionType;
+    isShrink?: boolean;
+    layerCount?: number;
+    selectionDirection?: number;
+    size?: number;
+    startingLocation?: minecraftserver.Vector3;
+}
+
 export interface SettingsUIElementOptions {
     dropdownItems?: string[];
     max?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-editor",
-  "version": "0.1.0-beta.1.21.70-preview.21",
+  "version": "0.1.0-beta.1.21.70-preview.23",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "dependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0-beta.1.21.70-preview.21"
+    "@minecraft/server": "^2.0.0-beta.1.21.70-preview.23"
   },
   "license": "MIT"
 }