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

package/index.d.ts

@@ -1015,6 +1015,13 @@ export declare enum ListPaneViewSortType {
     ZtoA = 2,
 }
 
+export declare enum ListViewControlFilterFlags {
+    None = 0,
+    Name = 1,
+    Tag = 2,
+    All = 3,
+}
+
 export enum LogChannel {
     /**
      * @remarks
@@ -1053,6 +1060,7 @@ export enum MinimapViewType {
      *
      */
     BlockView = 0,
+    CustomBiomeView = 1,
 }
 
 /**
@@ -1224,6 +1232,7 @@ export declare enum PropertyItemType {
     ProxyPane = 'editorUI:ProxyPane',
     String = 'editorUI:String',
     SubPane = 'editorUI:SubPane',
+    TagContainer = 'editorUI:TagContainer',
     Text = 'editorUI:Text',
     ToggleGroup = 'editorUI:ToggleGroup',
     Vector2 = 'editorUI:Vector2',
@@ -1264,6 +1273,14 @@ export enum StructureSource {
     Level = 3,
 }
 
+/**
+ * The possible variants of a TagContainer property item.
+ */
+export declare enum TagContainerVariant {
+    Primary = 0,
+    Inverted = 1,
+}
+
 export enum ThemeSettingsColorKey {
     Caret = 'Caret',
     Confirm1 = 'Confirm1',
@@ -1730,6 +1747,23 @@ export declare type ListPaneViewFilter = {
     tags?: string[];
 };
 
+/**
+ * Action item to be displayed on a list view control
+ */
+export type ListViewControlAction = {
+    id: string;
+} & ListViewControlActionState;
+
+/**
+ * Action item state for list view control
+ */
+export type ListViewControlActionState = {
+    label: LocalizedString;
+    icon: string;
+    disabled?: boolean;
+    displayInMenu?: boolean;
+};
+
 /**
  * Represents a localized string or an object with a localized
  * string and optional properties
@@ -2647,9 +2681,14 @@ export declare class ConeBrushShape extends BrushShape {
         width?: number;
         height?: number;
         depth?: number;
+        maxRadius?: number;
+        maxHeight?: number;
         xRotation?: number;
         yRotation?: number;
         zRotation?: number;
+        hollow?: boolean;
+        thickness?: number;
+        enableHollowSettings?: boolean;
     });
     applySetting(brushSettings: ConeBrushShapeSettings): void;
     calculateBounds(): minecraftserver.BlockBoundingBox;
@@ -2679,9 +2718,14 @@ export declare class CuboidBrushShape extends BrushShape {
         height?: number;
         depth?: number;
         minLength?: number;
+        maxLength?: number;
         xRotation?: number;
         yRotation?: number;
         zRotation?: number;
+        hollow?: boolean;
+        thickness?: number;
+        enableHollowSettings?: boolean;
+        hideRotation?: boolean;
     });
     applySetting(brushSettings: CuboidBrushShapeSettings): void;
     calculateBounds(): minecraftserver.BlockBoundingBox;
@@ -2960,10 +3004,15 @@ export declare class CylinderBrushShape extends BrushShape {
         height?: number;
         depth?: number;
         minRadius?: number;
+        maxRadius?: number;
+        maxHeight?: number;
         xRotation?: number;
         yRotation?: number;
         zRotation?: number;
         hideRotation?: boolean;
+        hollow?: boolean;
+        thickness?: number;
+        enableHollowSettings?: boolean;
     });
     applySetting(brushSettings: CylinderBrushShapeSettings): void;
     calculateBounds(): minecraftserver.BlockBoundingBox;
@@ -3162,9 +3211,13 @@ export declare class EllipsoidBrushShape extends BrushShape {
         height?: number;
         depth?: number;
         minRadius?: number;
+        maxRadius?: number;
         xRotation?: number;
         yRotation?: number;
         zRotation?: number;
+        hollow?: boolean;
+        thickness?: number;
+        enableHollowSettings?: boolean;
     });
     applySetting(brushSettings: EllipsoidBrushShapeSettings): void;
     calculateBounds(): minecraftserver.BlockBoundingBox;
@@ -3685,7 +3738,7 @@ export class MinimapManager {
      *
      * @throws This function can throw errors.
      */
-    createMinimap(viewType: MinimapViewType, mapWidth: number, mapHeight: number): MinimapItem;
+    createMinimap(viewType: MinimapViewType, mapWidth: number, mapHeight: number, dataId?: string): MinimapItem;
     /**
      * @remarks
      * Remove an existing minimap instance from the manager using
@@ -3865,9 +3918,14 @@ export declare class PyramidBrushShape extends BrushShape {
         width?: number;
         height?: number;
         depth?: number;
+        maxSide?: number;
+        maxHeight?: number;
         xRotation?: number;
         yRotation?: number;
         zRotation?: number;
+        hollow?: boolean;
+        thickness?: number;
+        enableHollowSettings?: boolean;
     });
     applySetting(brushSettings: PyramidBrushShapeSettings): void;
     calculateBounds(): minecraftserver.BlockBoundingBox;
@@ -5833,7 +5891,9 @@ export interface ClipboardWriteOptions {
 export interface ConeBrushShapeSettings {
     depth: number;
     height: number;
+    hollow: boolean;
     radius: number;
+    thickness: number;
     uniform: boolean;
     width: number;
     xRotation: number;
@@ -5858,6 +5918,8 @@ export interface ContiguousSelectionProperties {
 export interface CuboidBrushShapeSettings {
     depth: number;
     height: number;
+    hollow: boolean;
+    thickness: number;
     uniform: boolean;
     width: number;
     xRotation: number;
@@ -5952,7 +6014,9 @@ export interface CursorRay {
 export interface CylinderBrushShapeSettings {
     depth: number;
     height: number;
+    hollow: boolean;
     radius: number;
+    thickness: number;
     uniform: boolean;
     width: number;
     xRotation: number;
@@ -5975,7 +6039,9 @@ export interface EditorStructureSearchOptions {
 export interface EllipsoidBrushShapeSettings {
     depth: number;
     height: number;
+    hollow: boolean;
     radius: number;
+    thickness: number;
     uniform: boolean;
     width: number;
     xRotation: number;
@@ -7781,6 +7847,12 @@ export interface IListPanePropertyItem extends IPropertyItemBase, IPane {
      *
      */
     readonly slotCount: number;
+    /**
+     * @remarks
+     * View control pane for the list
+     *
+     */
+    readonly viewControlPane: IListPaneViewControlPane | undefined;
     /**
      * @remarks
      * Current sorting type for the pane slots
@@ -7793,6 +7865,14 @@ export interface IListPanePropertyItem extends IPropertyItemBase, IPane {
      *
      */
     addSlot(params: ListPaneSlotCreationProps): IListPaneSlot;
+    /**
+     * @remarks
+     * Creates a pane that displays view and filtering
+     * configurations for the list if the parent container supports
+     * it.
+     *
+     */
+    buildViewControl(options: IListPaneViewControlPaneOptions): IListPaneViewControlPane;
     /**
      * @remarks
      * Finds the slot with the identifier.
@@ -8070,6 +8150,117 @@ export interface IListPaneTextEntry extends IListPaneEntry {
     setValue(value: LocalizedString): void;
 }
 
+/**
+ * View control for a list pane to manage how slots are
+ * displayed
+ */
+export interface IListPaneViewControlPane {
+    /**
+     * @remarks
+     * Unique identifier
+     *
+     */
+    readonly id: string;
+    /**
+     * @remarks
+     * Active state of the filter
+     *
+     */
+    readonly isFilterActive: boolean;
+    /**
+     * @remarks
+     * Visible state of the pane
+     *
+     */
+    readonly visible: boolean;
+    /**
+     * @remarks
+     * Returns the state of an existing action
+     *
+     * @param id
+     * Identifier for the action
+     */
+    getActionState(id: string): ListViewControlActionState | undefined;
+    /**
+     * @remarks
+     * Updates enabled state of the existing action
+     *
+     * @param id
+     * Identifier for the action
+     * @param enabled
+     * New action enabled state
+     */
+    setActionEnabledState(id: string, enabled: boolean): void;
+    /**
+     * @remarks
+     * Updates existing actions
+     *
+     * @param newActions
+     * New actions
+     */
+    setActionStates(newActions: ListViewControlAction[]): void;
+    /**
+     * @remarks
+     * Updates visible state of the pane
+     *
+     * @param visible
+     * New visibility state
+     */
+    setVisible(visible: boolean): void;
+    /**
+     * @remarks
+     * Updates action item state for the view control
+     *
+     * @param id
+     * Identifier for the action
+     * @param newState
+     * New action state
+     */
+    updateActionState(id: string, newState: ListViewControlActionState): void;
+}
+
+export interface IListPaneViewControlPaneOptions {
+    /**
+     * @remarks
+     * Default actions
+     *
+     */
+    actions?: ListViewControlAction[];
+    /**
+     * @remarks
+     * Flags to determine visible filters. If undefined it will be
+     * All.
+     *
+     */
+    filterFlags?: ListViewControlFilterFlags;
+    /**
+     * @remarks
+     * This function will be called whenever user clicks an action
+     *
+     */
+    onActionClicked?: (id: string) => void;
+    /**
+     * @remarks
+     * This function will be called whenever the filter is changed
+     * by the user
+     *
+     */
+    onFilterChanged?: (visibleSlotIds: string[]) => void;
+    /**
+     * @remarks
+     * Custom sort options. If undefined, list pane sort options
+     * will be used.
+     *
+     */
+    sortOptions?: ListPaneViewSortType[];
+    /**
+     * @remarks
+     * Initial visibility state. It undefined, it will be false.
+     *
+     */
+    visible?: boolean;
+}
+
 export interface IMenu {
     /**
      * @remarks
@@ -9392,6 +9583,12 @@ export interface IPropertyPane extends IPane {
      *
      */
     addString(value: IObservableProp<string>, options?: IStringPropertyItemOptions): IStringPropertyItem;
+    /**
+     * @remarks
+     * Adds a tag container to the pane.
+     *
+     */
+    addTagContainer(options?: ITagContainerPropertyItemOptions): ITagContainerPropertyItem;
     /**
      * @remarks
      * Adds a multiline Text item to the pane.
@@ -9646,6 +9843,12 @@ export interface IRootPropertyPaneOptions extends IPropertyPaneOptions {
      *
      */
     headerAction?: IRootPropertyPaneHeaderAction;
+    /**
+     * @remarks
+     * Pane icon shown in front of the pane header
+     *
+     */
+    icon?: string;
 }
 
 /**
@@ -9885,6 +10088,12 @@ export interface ISubPanePropertyItemOptions extends IPropertyPaneOptions {
      *
      */
     hasMargins?: boolean;
+    /**
+     * @remarks
+     * Pane icon shown in front of the pane header
+     *
+     */
+    icon?: string;
     /**
      * @remarks
      * Determines layout of sub pane property items. If undefined,
@@ -9913,6 +10122,133 @@ export interface ISubPanePropertyItemOptions extends IPropertyPaneOptions {
     width?: number | LayoutSize;
 }
 
+/**
+ * A property item which supports Tag Container properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface ITagContainerPropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Current tags value of the property item.
+     *
+     */
+    readonly tags: ReadonlyArray<string>;
+    /**
+     * @remarks
+     * Current tags pool value of the property item.
+     *
+     */
+    readonly tagsPool: ReadonlyArray<string>;
+    /**
+     * @remarks
+     * Adds a tag to the current tags.
+     *
+     * @param tag
+     * Tag to add.
+     */
+    addTag(tag: string): void;
+    /**
+     * @remarks
+     * Adds a tag to the tags pool.
+     *
+     * @param tag
+     * Tag to add to the pool.
+     */
+    addTagToPool(tag: string): void;
+    /**
+     * @remarks
+     * Removes a tag from the current tags.
+     *
+     * @param tag
+     * Tag to remove.
+     */
+    removeTag(tag: string): void;
+    /**
+     * @remarks
+     * Removes a tag from the tags pool.
+     *
+     * @param tag
+     * Tag to remove from the pool.
+     */
+    removeTagFromPool(tag: string): void;
+    /**
+     * @remarks
+     * Updates all tags.
+     *
+     * @param tags
+     * New tags array.
+     */
+    setTags(tags: string[] | undefined): void;
+    /**
+     * @remarks
+     * Updates the tags pool.
+     *
+     * @param tagsPool
+     * New tags pool array.
+     */
+    setTagsPool(tagsPool: string[] | undefined): void;
+    /**
+     * @remarks
+     * Set title of the property item.
+     *
+     * @param title
+     * New title.
+     */
+    setTitle(title: LocalizedString): void;
+    /**
+     * @remarks
+     * Sets the visual variant of the tag container.
+     *
+     * @param variant
+     * New variant.
+     */
+    setVariant(variant: TagContainerVariant | undefined): void;
+}
+
+/**
+ * Optional properties for Tag Container property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface ITagContainerPropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * This callback is called when a tag is added.
+     *
+     */
+    onTagAdded?: (tag: string) => void;
+    /**
+     * @remarks
+     * This callback is called when a tag is removed.
+     *
+     */
+    onTagRemoved?: (tag: string) => void;
+    /**
+     * @remarks
+     * Initial tags for the container.
+     *
+     */
+    tags?: string[];
+    /**
+     * @remarks
+     * Available tags pool to select from.
+     *
+     */
+    tagsPool?: string[];
+    /**
+     * @remarks
+     * Localized title of the property item.
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Visual variant of the tag container. If undefined, it will
+     * default to Inverted.
+     *
+     */
+    variant?: TagContainerVariant;
+}
+
 /**
  * A property item which supports Text properties
  */
@@ -10601,6 +10937,8 @@ export interface ProjectExportOptions {
 export interface PyramidBrushShapeSettings {
     depth: number;
     height: number;
+    hollow: boolean;
+    thickness: number;
     uniform: boolean;
     width: number;
     xRotation: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-editor",
-  "version": "0.1.0-beta.1.26.10-preview.22",
+  "version": "0.1.0-beta.1.26.10-preview.24",
   "description": "",
   "contributors": [
     {
@@ -14,8 +14,8 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.7.0-beta.1.26.10-preview.22",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.10-preview.22"
+    "@minecraft/server": "^2.7.0-beta.1.26.10-preview.24",
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.10-preview.24"
   },
   "license": "MIT"
 }