@minecraft/server-editor 0.1.0-beta.1.21.10-preview.20 → 0.1.0-beta.1.21.10-preview.22

package/index.d.ts

@@ -14,7 +14,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-editor",
- *   "version": "0.1.0-beta.1.21.10-preview.20"
+ *   "version": "0.1.0-beta.1.21.10-preview.22"
  * }
  * ```
  *
@@ -36,6 +36,19 @@ export enum BlockPaletteItemType {
     Probability = 1,
 }
 
+export enum BrushPipelineOperationType {
+    Include = 0,
+    Exclude = 1,
+}
+
+/**
+ * Predefined action bar items
+ */
+export declare enum CoreActionBarItemType {
+    Redo = 'editor:actionBarItem:redo',
+    Undo = 'editor:actionBarItem:undo',
+}
+
 /**
  * Predefined top level menus for core editor
  */
@@ -122,6 +135,7 @@ export declare enum EDITOR_PANE_PROPERTY_ITEM_TYPE {
     Action = 'editorUI:Action',
     BlockPicker = 'editorUI:BlockPicker',
     Boolean = 'editorUI:Boolean',
+    ColorPicker = 'editorUI:ColorPicker',
     Divider = 'editorUI:Divider',
     Dropdown = 'editorUI:Dropdown',
     Image = 'editorUI:Image',
@@ -488,6 +502,7 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
     readonly actionManager: ActionManager;
     readonly inputManager: IGlobalInputManager;
     readonly menuBar: IMenuContainer;
+    readonly actionBar: IActionBar;
     readonly toolRail: IModalToolContainer;
     readonly log: IPlayerLogger;
     readonly extensionContext: ExtensionContext;
@@ -699,17 +714,52 @@ export class BlockPalette {
 
 export class BlockPaletteManager {
     private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    addOrReplacePalette(paletteId: string, palette: BlockPalette): void;
+    getPalette(paletteId: string): BlockPalette | undefined;
+    getPaletteIdList(): string[];
+    /**
+     * @throws This function can throw errors.
+     */
+    getPaletteItem(paletteId: string, index: number): IBlockPaletteItem;
+    getPrimaryPalette(): BlockPalette;
     /**
      * @throws This function can throw errors.
      */
     getSelectedBlockType(): minecraftserver.BlockType;
+    getSelectedItem(): IBlockPaletteItem;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    removePalette(paletteId: string): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setPaletteItem(paletteId: string, index: number, item: IBlockPaletteItem): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setPrimaryPalette(paletteId: string): void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
-    setSelectedBlockType(block: minecraftserver.BlockType): void;
+    setSelectedItem(item: IBlockPaletteItem): void;
 }
 
 export class BrushShapeManager {
@@ -724,6 +774,15 @@ export class BrushShapeManager {
      * @throws This function can throw errors.
      */
     activateBrushShape(name: string): minecraftserver.CompoundBlockVolume;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    getBrushVolume(
+        origin: minecraftserver.Vector3,
+        pipeline: BrushPipelineOperation[],
+    ): minecraftserver.CompoundBlockVolume | undefined;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2337,6 +2396,11 @@ export class WidgetStateChangeEventData {
     readonly widget: Widget;
 }
 
+export interface BrushPipelineOperation {
+    blockTypes: minecraftserver.BlockType[];
+    operation: BrushPipelineOperationType;
+}
+
 export interface BrushShape {
     icon: string;
     name: string;
@@ -2666,6 +2730,103 @@ export declare interface EventSink<T> {
     subscribe(handler: EventHandler<T>): IEventToken;
 }
 
+/**
+ * Manager for IActionBarItem objects.
+ */
+export interface IActionBar {
+    /**
+     * @remarks
+     * Add a new action bar item to the collection.
+     *
+     * @param id
+     * Unique item identifier.
+     * @param action
+     * Action to be invoked.
+     * @param props
+     * Configuration for the item to create.
+     */
+    registerItem(
+        id: string,
+        action: RegisteredAction<NoArgsAction>,
+        props: IActionBarItemCreationParams,
+    ): IActionBarItem;
+    /**
+     * @remarks
+     * Remove an action item from the collection.
+     *
+     * @param id
+     * Unique item identifier.
+     */
+    unregisterItem(id: string): void;
+}
+
+/**
+ * Registered item handle in the Action Bar collection.
+ */
+export interface IActionBarItem {
+    /**
+     * @remarks
+     * Returns the current enabled state of the item.
+     *
+     */
+    getEnabled: () => boolean;
+    /**
+     * @remarks
+     * Unique identifier of the item.
+     *
+     */
+    readonly id: string;
+    /**
+     * @remarks
+     * Text label of the item.
+     *
+     */
+    readonly label: string;
+    /**
+     * @remarks
+     * Modify enabled state of the item.
+     *
+     */
+    setEnabled: (enabled: boolean) => void;
+}
+
+/**
+ * Properties required to create an Action Bar item.
+ */
+export interface IActionBarItemCreationParams {
+    /**
+     * @remarks
+     * Initial enabled state of the item. If not defined, default
+     * is true.
+     *
+     */
+    enabled?: boolean;
+    /**
+     * @remarks
+     * Icon resource for the item.
+     *
+     */
+    icon: string;
+    /**
+     * @remarks
+     * Text label for item.
+     *
+     */
+    label: string;
+    /**
+     * @remarks
+     * Tooltip description for the item.
+     *
+     */
+    tooltipDescription?: string;
+    /**
+     * @remarks
+     * Tooltip title for the item.
+     *
+     */
+    tooltipTitle?: string;
+}
+
 /**
  * Simple abstraction for disposable objects.
  */
@@ -3016,6 +3177,11 @@ export interface IPropertyItemOptionsButton extends IPropertyItemOptions {
     variant?: ButtonVariant;
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IPropertyItemOptionsColorPicker extends IPropertyItemOptions {
+    showAlpha?: boolean;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IPropertyItemOptionsDataPicker extends IPropertyItemOptions {
     /**
@@ -3225,6 +3391,16 @@ export interface IPropertyPane {
         },
         'EMPTY'
     >;
+    /**
+     * @remarks
+     * Adds a color picker item to the pane.
+     *
+     */
+    addColorPicker<T extends PropertyBag, Prop extends keyof T & string>(
+        obj: T,
+        property: Prop,
+        options?: IPropertyItemOptionsColorPicker,
+    ): IPropertyItem<T, Prop>;
     /**
      * @remarks
      * Adds an divider item to the pane.

package/package.json

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