@minecraft/server-editor 0.1.0-beta.1.21.70-preview.22 → 0.1.0-beta.1.21.70-preview.24

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
  */
@@ -1504,7 +1518,7 @@ export declare class BedrockEventSubscriptionCache {
 export declare class BlockIdentifierObservableValidator implements ObservableValidator<string> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _defaultValue: string;
@@ -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 {
@@ -2223,7 +2262,7 @@ export class EditorStructureManager {
 export declare class EntityIdentifierObservableValidator implements ObservableValidator<string> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _defaultValue: string;
@@ -2407,17 +2446,44 @@ export class ExtensionContext {
  */
 export class ExtensionContextAfterEvents {
     private constructor();
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly clipboardChange: ClipboardChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly currentThemeChange: CurrentThemeChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly currentThemeColorChange: CurrentThemeColorChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly cursorPropertyChange: CursorPropertyChangeAfterEventSignal;
     /**
      * @remarks
      * This event triggers when the editor mode changes for the
      * player.
      *
+     * This property can be read in early-execution mode.
+     *
      */
     readonly modeChange: ModeChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly primarySelectionChange: PrimarySelectionChangeAfterEventSignal;
 }
 
@@ -2431,6 +2497,8 @@ export class GraphicsSettings {
      * @remarks
      * Retrieves a graphics settings property value.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param property
      * Property identifier.
      * @returns
@@ -2442,6 +2510,8 @@ export class GraphicsSettings {
      * @remarks
      * Retrieves all graphics settings properties and their values.
      *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * Returns a property value map for all available properties.
      */
@@ -2450,6 +2520,8 @@ export class GraphicsSettings {
      * @remarks
      * Modifies a graphics settings property value.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param property
      * Property identifier.
      * @param value
@@ -2461,6 +2533,8 @@ export class GraphicsSettings {
      * @remarks
      * Modify multiple graphics settings properties.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param properties
      * Property map to set available property values. If the
      * property is not defined in the map, it will not be modified.
@@ -2633,19 +2707,19 @@ export class ModeChangeAfterEventSignal {
 export declare class NumberLimitObservableValidator implements ObservableValidator<number> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _isInteger?: boolean;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _max?: number;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _min?: number;
@@ -2712,6 +2786,11 @@ export class PrimarySelectionChangedEvent {
 
 // @ts-ignore Class inheritance allowed for native defined classes
 export class ProbabilityBlockPaletteItem extends IBlockPaletteItem {
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(displayName?: string);
     /**
      * @remarks
@@ -3005,6 +3084,11 @@ export class SettingsUIElement {
     readonly name: string;
     readonly onChange: (arg0: boolean | number | string | minecraftserver.Vector3) => void;
     readonly options: SettingsUIElementOptions;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(
         name: string,
         initialValue: boolean | number | string | minecraftserver.Vector3,
@@ -3015,6 +3099,11 @@ export class SettingsUIElement {
 
 // @ts-ignore Class inheritance allowed for native defined classes
 export class SimpleBlockPaletteItem extends IBlockPaletteItem {
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(displayName?: string);
 }
 
@@ -3085,13 +3174,29 @@ export class SimulationState {
 
 export class SpeedSettings {
     private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     get<T extends keyof SpeedSettingsPropertyTypeMap>(property: T): SpeedSettingsPropertyTypeMap[T] | undefined;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     getAll(): SpeedSettingsPropertyTypeMap;
     /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     set<T extends keyof SpeedSettingsPropertyTypeMap>(property: T, value: SpeedSettingsPropertyTypeMap[T]): void;
     /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     setAll(properties: SpeedSettingsPropertyTypeMap): void;
@@ -3448,19 +3553,19 @@ export class UserDefinedTransactionHandlerId {
 export declare class Vector3LimitObservableValidator implements ObservableValidator<minecraftserver.Vector3> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _isInteger?: boolean;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _max: Partial<minecraftserver.Vector3>;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _min: Partial<minecraftserver.Vector3>;
@@ -3826,6 +3931,11 @@ export class WidgetComponentRenderPrimitiveTypeAxialSphere extends WidgetCompone
      *
      */
     radius: number;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(center: minecraftserver.Vector3, radius: number, color?: minecraftserver.RGBA);
 }
 
@@ -3854,6 +3964,11 @@ export class WidgetComponentRenderPrimitiveTypeBox extends WidgetComponentRender
      *
      */
     size?: minecraftserver.Vector3;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(center: minecraftserver.Vector3, color: minecraftserver.RGBA, size?: minecraftserver.Vector3);
 }
 
@@ -3877,6 +3992,11 @@ export class WidgetComponentRenderPrimitiveTypeDisc extends WidgetComponentRende
      *
      */
     radius: number;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(center: minecraftserver.Vector3, radius: number, color: minecraftserver.RGBA);
 }
 
@@ -3900,6 +4020,11 @@ export class WidgetComponentRenderPrimitiveTypeLine extends WidgetComponentRende
      *
      */
     start: minecraftserver.Vector3;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
     constructor(start: minecraftserver.Vector3, end: minecraftserver.Vector3, color: minecraftserver.RGBA);
 }
 
@@ -4187,6 +4312,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 +4786,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
  */
@@ -5298,9 +5464,15 @@ export interface IModalControlPane extends IPane {
      *
      */
     addButton(
-        action: (() => void) | RegisteredAction<NoArgsAction>,
+        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.
@@ -5921,13 +6093,19 @@ export interface IPropertyPane extends IPane {
     /**
      * @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.
@@ -7307,6 +7485,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.22",
+  "version": "0.1.0-beta.1.21.70-preview.24",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "dependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0-beta.1.21.70-preview.22"
+    "@minecraft/server": "^2.0.0-beta.1.21.70-preview.24"
   },
   "license": "MIT"
 }