@minecraft/server-editor 0.1.0-beta.1.21.110-preview.26 → 0.1.0-beta.1.21.120-preview.21

package/index.d.ts

@@ -313,6 +313,11 @@ export enum GamePublishSetting {
  * properties.
  */
 export enum GraphicsSettingsProperty {
+    DisableBlockEntityRendering = 'DisableBlockEntityRendering',
+    DisableEntityRendering = 'DisableEntityRendering',
+    DisableParticleRendering = 'DisableParticleRendering',
+    DisableTerrainRendering = 'DisableTerrainRendering',
+    DisableWeatherRendering = 'DisableWeatherRendering',
     GraphicsMode = 'GraphicsMode',
     NightVision = 'NightVision',
     ShowChunkBoundaries = 'ShowChunkBoundaries',
@@ -1100,6 +1105,7 @@ export declare enum PropertyItemType {
     Dropdown = 'editorUI:Dropdown',
     Image = 'editorUI:Image',
     Link = 'editorUI:Link',
+    Menu = 'editorUI:Menu',
     Number = 'editorUI:Number',
     NumberTimeline = 'editorUI:NumberTimeline',
     ProgressIndicator = 'editorUI:ProgressIndicator',
@@ -1108,6 +1114,7 @@ export declare enum PropertyItemType {
     SubPane = 'editorUI:SubPane',
     Text = 'editorUI:Text',
     ToggleGroup = 'editorUI:ToggleGroup',
+    Vector2 = 'editorUI:Vector2',
     Vector3 = 'editorUI:Vector3',
 }
 
@@ -1212,11 +1219,18 @@ export enum ThemeSettingsColorKey {
     Warning = 'Warning',
 }
 
+export enum WidgetCollisionType {
+    None = 0,
+    Radius = 1,
+    Bounds = 2,
+}
+
 export enum WidgetComponentType {
     BoundingBox = 'BoundingBox',
     Clipboard = 'Clipboard',
     Entity = 'Entity',
     Gizmo = 'Gizmo',
+    Grid = 'Grid',
     Guide = 'Guide',
     RenderPrim = 'RenderPrim',
     Spline = 'Spline',
@@ -1318,6 +1332,11 @@ export type GraphicsSettingsPropertyTypeMap = {
     [GraphicsSettingsProperty.ShowCompass]?: boolean;
     [GraphicsSettingsProperty.NightVision]?: boolean;
     [GraphicsSettingsProperty.ShowToastNotifications]?: boolean;
+    [GraphicsSettingsProperty.DisableEntityRendering]?: boolean;
+    [GraphicsSettingsProperty.DisableTerrainRendering]?: boolean;
+    [GraphicsSettingsProperty.DisableWeatherRendering]?: boolean;
+    [GraphicsSettingsProperty.DisableParticleRendering]?: boolean;
+    [GraphicsSettingsProperty.DisableBlockEntityRendering]?: boolean;
 };
 
 /**
@@ -2435,6 +2454,12 @@ export class EditorConstants {
 
 export class EditorStructure {
     private constructor();
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly description: string;
     /**
      * @throws This property can throw when used.
      *
@@ -2443,12 +2468,54 @@ export class EditorStructure {
     readonly displayName: string;
     readonly id: string;
     readonly isValid: boolean;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly normalizedOrigin: minecraftserver.Vector3;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly notes: string;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly offset: minecraftserver.Vector3;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly originalWorldLocation: minecraftserver.Vector3;
     /**
      * @throws This property can throw when used.
      *
      * {@link minecraftserver.InvalidStructureError}
      */
     readonly size: minecraftserver.Vector3;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly structureFullName: string;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly structureName: string;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly structureNamespace: string;
     /**
      * @throws This function can throw errors.
      *
@@ -2507,14 +2574,14 @@ export class EditorStructureManager {
      *
      * @throws This function can throw errors.
      */
-    createEmpty(id: string, size: minecraftserver.Vector3): EditorStructure;
+    createEmpty(fullName: string, size: minecraftserver.Vector3): EditorStructure;
     /**
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
-    createFromClipboardItem(item: ClipboardItem, structureName: string): EditorStructure;
+    createFromClipboardItem(item: ClipboardItem, fullName: string): EditorStructure;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2535,7 +2602,7 @@ export class EditorStructureManager {
      *
      * @throws This function can throw errors.
      */
-    getOrCreateStructure(id: string): EditorStructure;
+    getStructure(id: string): EditorStructure;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -3734,6 +3801,40 @@ export class UserDefinedTransactionHandlerId {
     private constructor();
 }
 
+/**
+ * Validates min/max limits of observable objects that support
+ * Vector2
+ */
+export declare class Vector2LimitObservableValidator implements ObservableValidator<minecraftserver.Vector2> {
+    /**
+     * @remarks
+     * This property can't be used in read-only mode.
+     *
+     */
+    protected _isInteger?: boolean;
+    /**
+     * @remarks
+     * This property can't be used in read-only mode.
+     *
+     */
+    protected _max: Partial<minecraftserver.Vector2>;
+    /**
+     * @remarks
+     * This property can't be used in read-only mode.
+     *
+     */
+    protected _min: Partial<minecraftserver.Vector2>;
+    /**
+     * @remarks
+     * Constructs a new instance of the
+     * `Vector2LimitObservableValidator` class
+     *
+     */
+    constructor(min: Partial<minecraftserver.Vector2>, max: Partial<minecraftserver.Vector2>, isInteger?: boolean);
+    updateLimits(min: Partial<minecraftserver.Vector2>, max: Partial<minecraftserver.Vector2>): void;
+    validate(newValue: minecraftserver.Vector2): minecraftserver.Vector2;
+}
+
 /**
  * Validates min/max limits of observable objects that support
  * Vector3
@@ -3788,6 +3889,12 @@ export class Widget {
      *
      */
     collisionRadius: number;
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    collisionType: WidgetCollisionType;
     /**
      * @throws This property can throw when used.
      *
@@ -3863,6 +3970,13 @@ export class Widget {
      * @throws This function can throw errors.
      */
     addGizmoComponent(componentName: string, options?: WidgetComponentGizmoOptions): WidgetComponentGizmo;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    addGridComponent(componentName: string, options?: WidgetComponentGridOptions): WidgetComponentGrid;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -4173,6 +4287,35 @@ export class WidgetComponentGizmoStateChangeEventParameters {
     readonly widget: Widget;
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export class WidgetComponentGrid extends WidgetComponentBase {
+    private constructor();
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    gridColor: minecraftserver.RGBA;
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    gridCount: minecraftserver.Vector2;
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    gridSize: minecraftserver.Vector2;
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    plane: Plane;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class WidgetComponentGuide extends WidgetComponentBase {
     private constructor();
@@ -4234,6 +4377,12 @@ export class WidgetComponentRenderPrimitiveTypeAxialSphere extends WidgetCompone
 export class WidgetComponentRenderPrimitiveTypeBase {
     private constructor();
     readonly primitiveType: PrimitiveType;
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
+    renderPriority: number;
 }
 
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -4764,9 +4913,11 @@ export interface CursorRay {
 
 export interface EditorStructureSearchOptions {
     displayName?: string;
-    idPattern?: string;
-    includeSources?: StructureSource[];
-    includeTags?: string[];
+    id?: string;
+    sources?: StructureSource[];
+    structureName?: string;
+    structureNamespace?: string;
+    tags?: string[];
 }
 
 /**
@@ -5496,6 +5647,20 @@ export interface IColorTimelinePropertyItemOptions extends IPropertyItemOptionsB
      *
      */
     onTimeChanged?: (current: number, prev: number) => void;
+    /**
+     * @remarks
+     * Flag that enables gradient background color on the timeline
+     * to be rendered, default is true
+     *
+     */
+    renderGradientBackground?: boolean;
+    /**
+     * @remarks
+     * False means the alpha elements will not be shown in the
+     * color picker
+     *
+     */
+    showAlpha?: boolean;
     /**
      * @remarks
      * Localized title of the property item
@@ -6093,6 +6258,86 @@ export interface IMenuCreationParams {
     uniqueId?: string;
 }
 
+/**
+ * A property item which supports Menu properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IMenuPropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Adds a new menu item entry to property item
+     *
+     * @param props
+     * Menu creation parameters
+     * @param action
+     * Optional action to trigger on menu click
+     */
+    addEntry(props: IMenuCreationParams, action?: RegisteredAction<NoArgsAction>): IMenu;
+    /**
+     * @remarks
+     * @returns
+     * All first level menu entries
+     */
+    getEntries(): IMenu[];
+    /**
+     * @remarks
+     * Find the menu item recursively if it exists
+     *
+     * @param menuId
+     * Identifier of the menu.
+     */
+    getMenu(menuId: string): IMenu | undefined;
+    /**
+     * @remarks
+     * Removed the menu item entry if the id is found
+     *
+     * @param menuId
+     * Menu id to remove
+     */
+    removeEntry(menuId: string): void;
+    /**
+     * @remarks
+     * Updates title of the property item.
+     *
+     * @param title
+     * New title.
+     */
+    setTitle(title: LocalizedString | undefined): void;
+    /**
+     * @remarks
+     * Updates tooltip description of property item.
+     *
+     * @param tooltip
+     * New tooltip.
+     */
+    setTooltip(tooltip: BasicTooltipContent | undefined): void;
+}
+
+/**
+ * Optional properties for Menu property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IMenuPropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * Called when a menu item is clicked.
+     *
+     */
+    onMenuItemClick?: (menuId: string) => void;
+    /**
+     * @remarks
+     * Localized title of the property item.
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Tooltip description of the property item.
+     *
+     */
+    tooltip?: BasicTooltipContent;
+}
+
 /**
  * A sub pane for modal control elements.
  */
@@ -6812,7 +7057,7 @@ export interface IPropertyPane extends IPane {
      * Pane state for being expanded or collapsed.
      *
      */
-    collapsed: boolean;
+    readonly collapsed: boolean;
     /**
      * @remarks
      * Provides visibility change events
@@ -6910,6 +7155,18 @@ export interface IPropertyPane extends IPane {
      *
      */
     addLink(value: IObservableProp<string>, options?: ILinkPropertyItemOptions): ILinkPropertyItem;
+    /**
+     * @remarks
+     * Adds a menu button property item to the pane.
+     *
+     */
+    addMenu(
+        defaultEntries: {
+            params: IMenuCreationParams;
+            action?: RegisteredAction<NoArgsAction>;
+        }[],
+        options?: IMenuPropertyItemOptions,
+    ): IMenuPropertyItem;
     /**
      * @remarks
      * Adds a number item to the pane.
@@ -6957,7 +7214,16 @@ export interface IPropertyPane extends IPane {
     addToggleGroup(value: IObservableProp<number>, options?: IToggleGroupPropertyItemOptions): IToggleGroupPropertyItem;
     /**
      * @remarks
-     * Adds a Vec3 item to the pane.
+     * Adds a Vector2 item to the pane.
+     *
+     */
+    addVector2(
+        value: IObservableProp<minecraftserver.Vector2>,
+        options?: IVector2PropertyItemOptions,
+    ): IVector2PropertyItem;
+    /**
+     * @remarks
+     * Adds a Vector3 item to the pane.
      *
      */
     addVector3(
@@ -6989,6 +7255,12 @@ export interface IPropertyPane extends IPane {
      *
      */
     endConstruct(): void;
+    /**
+     * @remarks
+     * Expand the pane.
+     *
+     */
+    expand(): void;
     /**
      * @remarks
      * Returns pane title.
@@ -7582,6 +7854,94 @@ export interface IToggleGroupPropertyItemOptions extends IPropertyItemOptionsBas
     tooltip?: BasicTooltipContent;
 }
 
+/**
+ * A property item which supports Vector2 properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IVector2PropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Current value of the property item.
+     *
+     */
+    readonly value: Readonly<minecraftserver.Vector2>;
+    /**
+     * @remarks
+     * Updates title of the button.
+     *
+     * @param title
+     * New button title.
+     */
+    setTitle(title: LocalizedString | undefined): void;
+    /**
+     * @remarks
+     * Updates tooltip description of the button.
+     *
+     * @param tooltip
+     * New button tooltip.
+     */
+    setTooltip(tooltip: BasicTooltipContent | undefined): void;
+    /**
+     * @remarks
+     * Updates Vector2 limits and clamps the current value.
+     *
+     */
+    updateAxisLimits(limits: { min?: Partial<minecraftserver.Vector2>; max?: Partial<minecraftserver.Vector2> }): void;
+}
+
+/**
+ * Optional properties for Vector2 property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IVector2PropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * If true label text will be hidden. It will be visible by
+     * default.
+     *
+     */
+    hiddenLabel?: boolean;
+    /**
+     * @remarks
+     * If we should treat the Vector2 properties as integer values.
+     * By default is false.
+     *
+     */
+    isInteger?: boolean;
+    /**
+     * @remarks
+     * The min possible limits. If undefined,
+     * Number.MAX_SAFE_INTEGER will be used.
+     *
+     */
+    max?: Partial<minecraftserver.Vector2>;
+    /**
+     * @remarks
+     * The min possible limits. If undefined,
+     * Number.MIN_SAFE_INTEGER will be used.
+     *
+     */
+    min?: Partial<minecraftserver.Vector2>;
+    /**
+     * @remarks
+     * This callback is called when UI control is changed.
+     *
+     */
+    onChange?: (newValue: minecraftserver.Vector2, oldValue: minecraftserver.Vector2) => void;
+    /**
+     * @remarks
+     * Localized title of the property item
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Tooltip description of the property item
+     *
+     */
+    tooltip?: BasicTooltipContent;
+}
+
 /**
  * A property item which supports Vector3 properties
  */
@@ -7815,6 +8175,14 @@ export interface WidgetComponentGizmoOptions extends WidgetComponentBaseOptions
     stateChangeEvent?: (arg0: WidgetComponentGizmoStateChangeEventParameters) => void;
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface WidgetComponentGridOptions extends WidgetComponentBaseOptions {
+    color?: minecraftserver.RGBA;
+    gridCount?: minecraftserver.Vector2;
+    gridSize?: minecraftserver.Vector2;
+    plane?: Plane;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface WidgetComponentGuideOptions extends WidgetComponentBaseOptions {}
 
@@ -7850,6 +8218,7 @@ export interface WidgetCreateOptions {
     bindPositionToBlockCursor?: boolean;
     collisionOffset?: minecraftserver.Vector3;
     collisionRadius?: number;
+    collisionType?: WidgetCollisionType;
     lockToSurface?: boolean;
     selectable?: boolean;
     snapToBlockLocation?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-editor",
-  "version": "0.1.0-beta.1.21.110-preview.26",
+  "version": "0.1.0-beta.1.21.120-preview.21",
   "description": "",
   "contributors": [
     {
@@ -14,8 +14,8 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.3.0-beta.1.21.110-preview.26",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.21.110-preview.26"
+    "@minecraft/server": "^2.4.0-beta.1.21.120-preview.21",
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.21.120-preview.21"
   },
   "license": "MIT"
 }