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

package/index.d.ts

@@ -31,6 +31,11 @@ export declare enum ActionTypes {
     NoArgsAction = 'NoArgsAction',
 }
 
+export enum BlockMaskListType {
+    Mask = 'Mask',
+    Replace = 'Replace',
+}
+
 export enum BlockPaletteItemType {
     Simple = 0,
     Probability = 1,
@@ -44,11 +49,6 @@ export declare enum BoolPropertyItemVariant {
     ToggleSwitch = 1,
 }
 
-export enum BrushPipelineOperationType {
-    Include = 0,
-    Exclude = 1,
-}
-
 /**
  * The possible variants of a Button property item.
  */
@@ -1078,7 +1078,7 @@ export type IObservableProp<T> = IObservable<T> | T;
  */
 export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
     createStatusBarItem(alignment: EditorStatusBarAlignment, size: number): IStatusBarItem;
-    createPropertyPane(options: IPropertyPaneOptions): IPropertyPane;
+    createPropertyPane(options: IRootPropertyPaneOptions): IRootPropertyPane;
     readonly actionManager: ActionManager;
     readonly inputManager: IGlobalInputManager;
     readonly menuBar: IMenuContainer;
@@ -1399,12 +1399,14 @@ export class BrushShapeManager {
     private constructor();
     readonly activeBrushShape?: BrushShape;
     readonly activeBrushVolume?: minecraftserver.CompoundBlockVolume;
-    readonly brushShapeNames: string[];
+    readonly brushShapeList: BrushShape[];
     /**
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.Error}
      */
     activateBrushShape(name: string): minecraftserver.CompoundBlockVolume;
     /**
@@ -1412,15 +1414,32 @@ export class BrushShapeManager {
      * This function can't be called in read-only mode.
      *
      */
-    getBrushVolume(
-        origin: minecraftserver.Vector3,
-        pipeline: BrushPipelineOperation[],
-    ): minecraftserver.CompoundBlockVolume | undefined;
+    activateBrushTool(): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    beginPainting(): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    deactivateBrushTool(): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    endPainting(): void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link Error}
      */
     getSettingsUIElements(brushName: string): SettingsUIElement[];
     /**
@@ -1428,6 +1447,8 @@ export class BrushShapeManager {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link Error}
      */
     registerBrushShape(
         name: string,
@@ -1440,6 +1461,34 @@ export class BrushShapeManager {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link Error}
+     */
+    setBlockPaletteOverride(
+        overrideBlock?: minecraftserver.BlockPermutation | minecraftserver.BlockType | string,
+    ): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
+     */
+    setBrushMask(mask: BlockMaskList): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setBrushShape(shape: minecraftserver.Vector3[] | minecraftserver.CompoundBlockVolume): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
      */
     uiSettingValueChanged(elementName: string, newValue: boolean | number | string | minecraftserver.Vector3): boolean;
 }
@@ -1565,6 +1614,15 @@ export class ClipboardItem {
      * @throws This function can throw errors.
      */
     readFromSelection(selection: Selection): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link Error}
+     */
+    readFromStructure(structure: EditorStructure): void;
     /**
      * @remarks
      * Copy the contents of a rectangular volume into the Clipboard
@@ -1634,6 +1692,51 @@ export class ClipboardManager {
     create(): ClipboardItem;
 }
 
+export class CurrentThemeChangeAfterEvent {
+    private constructor();
+    readonly name: string;
+}
+
+export class CurrentThemeChangeAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    subscribe(callback: (arg: CurrentThemeChangeAfterEvent) => void): (arg: CurrentThemeChangeAfterEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    unsubscribe(callback: (arg: CurrentThemeChangeAfterEvent) => void): void;
+}
+
+export class CurrentThemeColorChangeAfterEvent {
+    private constructor();
+    readonly color: minecraftserver.RGBA;
+    readonly colorKey: ThemeSettingsColorKey;
+}
+
+export class CurrentThemeColorChangeAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    subscribe(
+        callback: (arg: CurrentThemeColorChangeAfterEvent) => void,
+    ): (arg: CurrentThemeColorChangeAfterEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    unsubscribe(callback: (arg: CurrentThemeColorChangeAfterEvent) => void): void;
+}
+
 /**
  * The 3D block cursor is controlled through this read only
  * object and provides the Editor some control over the input
@@ -1831,6 +1934,45 @@ export class CursorPropertyChangeAfterEventSignal {
     unsubscribe(callback: (arg: CursorPropertiesChangeAfterEvent) => void): void;
 }
 
+export class EditorStructureManager {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    createFromClipboardItem(item: ClipboardItem, structureName: string): EditorStructure;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    getExistingTags(): string[];
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    loadStructure(location: string, id: string): EditorStructure;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    saveStructure(structure: EditorStructure): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    searchStructures(options?: EditorStructureSearchOptions): EditorStructure[];
+}
+
 /**
  * Validates observable objects that support string as
  * EntityType
@@ -2003,6 +2145,7 @@ export class ExtensionContext {
      *
      */
     readonly settings: SettingsManager;
+    readonly structureManager: EditorStructureManager;
     /**
      * @remarks
      * The instance of the players Transaction Manager and the main
@@ -2021,6 +2164,8 @@ export class ExtensionContext {
 export class ExtensionContextAfterEvents {
     private constructor();
     readonly clipboardChange: ClipboardChangeAfterEventSignal;
+    readonly currentThemeChange: CurrentThemeChangeAfterEventSignal;
+    readonly currentThemeColorChange: CurrentThemeColorChangeAfterEventSignal;
     readonly cursorAttachmentPropertyChange: CursorAttachmentPropertyChangeAfterEventSignal;
     readonly cursorPropertyChange: CursorPropertyChangeAfterEventSignal;
     /**
@@ -2697,6 +2842,7 @@ export class ThemeSettings {
      * {@link Error}
      */
     addNewTheme(name: string): void;
+    canThemeBeModified(name: string): boolean;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2708,7 +2854,7 @@ export class ThemeSettings {
     deleteTheme(name: string): void;
     getCurrentTheme(): string;
     getThemeList(): string[];
-    resolveColorKey(key: ThemeSettingsColorKey): minecraftserver.RGBA | undefined;
+    resolveColorKey(key: ThemeSettingsColorKey): minecraftserver.RGBA;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -3571,9 +3717,9 @@ export class WidgetStateChangeEventData {
     readonly widget: Widget;
 }
 
-export interface BrushPipelineOperation {
-    blockTypes: minecraftserver.BlockType[];
-    operation: BrushPipelineOperationType;
+export interface BlockMaskList {
+    blockList: (minecraftserver.BlockPermutation | minecraftserver.BlockType | string)[];
+    maskType: BlockMaskListType;
 }
 
 export interface BrushShape {
@@ -3709,6 +3855,19 @@ export interface CursorProperties {
     visible?: boolean;
 }
 
+export interface EditorStructure {
+    storageLocation: string;
+    structure: minecraftserver.Structure;
+    tags: string[];
+}
+
+export interface EditorStructureSearchOptions {
+    excludeTags?: string[];
+    idPattern?: string;
+    includeLocation?: string[];
+    includeTags?: string[];
+}
+
 /**
  * An interface which defines the set of optional parameters
  * which can be used when calling the `registerEditorExtension`
@@ -3764,6 +3923,7 @@ export interface GameOptions {
     fireSpreads?: boolean;
     friendlyFire?: boolean;
     gameMode?: minecraftserver.GameMode;
+    hardcore?: boolean;
     immediateRespawn?: boolean;
     keepInventory?: boolean;
     lanVisibility?: boolean;
@@ -3869,6 +4029,15 @@ export interface WidgetComponentTextOptions extends WidgetComponentBaseOptions {
     color?: minecraftserver.RGBA;
 }
 
+export interface WidgetCreateOptions {
+    collisionOffset?: minecraftserver.Vector3;
+    collisionRadius?: number;
+    selectable?: boolean;
+    snapToBlockLocation?: boolean;
+    stateChangeEvent?: (arg: WidgetStateChangeEventData) => void;
+    visible?: boolean;
+}
+
 export interface WidgetGroupCreateOptions {
     groupSelectionMode?: WidgetGroupSelectionMode;
     showBounds?: boolean;
@@ -3881,12 +4050,6 @@ export interface WidgetGroupCreateOptions {
  * client side UI is per player.
  */
 export interface ActionManager {
-    /**
-     * @remarks
-     * The active tool ID
-     *
-     */
-    activeToolId: string | undefined;
     /**
      * @remarks
      * Creates an action and registers it on the client
@@ -4730,18 +4893,10 @@ export interface IModalToolContainer {
      *
      */
     readonly currentTools: IModalTool[];
-    /**
-     * @remarks
-     * The id of the selected tool in container.
-     *
-     */
-    readonly selectedOptionId?: string;
     addTool(params: ModalToolCreationParameters, action?: RegisteredAction<NoArgsAction>): IModalTool;
-    dispose(): void;
-    hide(): void;
+    getSelectedToolId(): string | undefined;
     removeTool(id: string): void;
-    setSelectedOptionId(value: string | undefined, update?: boolean): void;
-    show(): void;
+    setSelectedToolId(id: string | undefined): void;
 }
 
 /**
@@ -5157,30 +5312,12 @@ export interface IPropertyPane {
      *
      */
     onPropertyPaneVisibilityUpdated: EventSink<PropertyPaneVisibilityUpdate>;
-    /**
-     * @remarks
-     * In case of sub pane this is the id of the parent pane.
-     *
-     */
-    readonly parentPaneId?: string;
-    /**
-     * @remarks
-     * Localized title of the property pane
-     *
-     */
-    title: string;
     /**
      * @remarks
      * Check visibility of the pane
      *
      */
     visible: boolean;
-    /**
-     * @remarks
-     * Width of the panel in rem.
-     *
-     */
-    width?: number;
     /**
      * @remarks
      * Adds a block list to the pane.
@@ -5351,17 +5488,22 @@ export interface IPropertyPane {
     collapse(): void;
     /**
      * @remarks
-     * Creates an internal sub panel that is presented inside a
-     * extender control.
+     * Creates an sub pane that can store property items.
      *
      */
-    createPropertyPane(options: IPropertyPaneOptions): IPropertyPane;
+    createSubPane(options: ISubPanePropertyItemOptions): ISubPanePropertyItem;
     /**
      * @remarks
      * Expand the pane.
      *
      */
     expand(): void;
+    /**
+     * @remarks
+     * Returns property pane title.
+     *
+     */
+    getTitle(): LocalizedString | undefined;
     /**
      * @remarks
      * Hide the pane.
@@ -5370,10 +5512,18 @@ export interface IPropertyPane {
     hide(): void;
     /**
      * @remarks
-     * Removes a child property pane from the parent pane.
+     * Removes an existing sub pane.
      *
      */
-    removePropertyPane(paneToRemove: IPropertyPane): boolean;
+    removeSubPane(paneToRemove: IPropertyPane): boolean;
+    /**
+     * @remarks
+     * Updates title of property pane.
+     *
+     * @param newTitle
+     * New title
+     */
+    setTitle(newTitle: LocalizedString | undefined): void;
     /**
      * @remarks
      * Show the pane and all of its property items.
@@ -5383,21 +5533,16 @@ export interface IPropertyPane {
 }
 
 /**
- * The options to create a pane.
+ * Common optional properties used for constructing a property
+ * pane.
  */
 export interface IPropertyPaneOptions {
-    /**
-     * @remarks
-     * Layout direction for sub panes
-     *
-     */
-    direction?: LayoutDirection;
     /**
      * @remarks
      * Localized title of the property pane
      *
      */
-    title: string;
+    title?: LocalizedString;
 }
 
 export interface IPropertyTableCellItem {
@@ -5434,6 +5579,50 @@ export interface IRegisterExtensionOptionalParameters {
     toolGroupId?: string;
 }
 
+/**
+ * A root pane that can store property items.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IRootPropertyPane extends IPropertyPane {
+    /**
+     * @remarks
+     * @returns
+     * Current visibility state of header action
+     */
+    isHeaderActionVisible(): boolean;
+    /**
+     * @remarks
+     * If a header action exists, updates visibility of the button.
+     *
+     * @param visible
+     * New visibility state of the action button.
+     */
+    setHeaderActionVisibility(visible: boolean): void;
+}
+
+/**
+ * Represents the data to display an action button on a root
+ * property pane header.
+ */
+export interface IRootPropertyPaneHeaderAction {
+    action?: () => void;
+    icon: string;
+    tooltip?: LocalizedString;
+}
+
+/**
+ * The options to create a root pane.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IRootPropertyPaneOptions extends IPropertyPaneOptions {
+    /**
+     * @remarks
+     * Optional action button to be displayed on the header.
+     *
+     */
+    headerAction?: IRootPropertyPaneHeaderAction;
+}
+
 /**
  * The simple tool wrapper will create, bind and manage the
  * lifecycle of all the desired components. The wrapper is
@@ -6004,6 +6193,71 @@ export interface IStringPropertyItemOptions extends IPropertyItemOptionsBase {
     tooltip?: LocalizedString;
 }
 
+/**
+ * A property item which supports Sub Pane properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface ISubPanePropertyItem extends IPropertyItemBase, IPropertyPane {
+    /**
+     * @remarks
+     * Updates layout alignment of the sub pane.
+     *
+     * @param alignment
+     * New layout alignment.
+     */
+    setAlignment(alignment: LayoutAlignment): void;
+    /**
+     * @remarks
+     * Updates layout direction of the sub pane.
+     *
+     * @param direction
+     * New layout direction.
+     */
+    setDirection(direction: LayoutDirection): void;
+}
+
+/**
+ * Optional properties for Sub Pane property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface ISubPanePropertyItemOptions extends IPropertyPaneOptions {
+    /**
+     * @remarks
+     * Alignment of property items within the pane of the property
+     * pane. If undefined, it will default to Left.
+     *
+     */
+    alignment?: LayoutAlignment;
+    /**
+     * @remarks
+     * Initial expander state of sub pane. If undefined, it will
+     * default to false.
+     *
+     */
+    collapsed?: boolean;
+    /**
+     * @remarks
+     * Determines layout direction of sub pane property items. If
+     * undefined, it will default to Vertical.
+     *
+     */
+    direction?: LayoutDirection;
+    /**
+     * @remarks
+     * Determines if sub pane should have an expander. If
+     * undefined, it will default to true.
+     *
+     */
+    hasExpander?: boolean;
+    /**
+     * @remarks
+     * Adds additional margins to sub pane. If undefined, it will
+     * default to true.
+     *
+     */
+    hasMargins?: boolean;
+}
+
 /**
  * A property item which supports Vector3 properties
  */

package/package.json

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