@minecraft/server-editor 0.1.0-beta.1.21.130-preview.25 → 0.1.0-beta.1.21.130-preview.27

package/index.d.ts

@@ -93,10 +93,15 @@ export enum BrushDirectionalPlacementMode {
     Random3Axes = 14,
 }
 
+export enum BrushElevationMode {
+    Raise = 0,
+    Lower = 1,
+}
+
 /**
  * The possible variants of a Button property item.
  */
-export declare enum ButtonPropertyItemVariant {
+export declare enum ButtonVariant {
     Primary = 0,
     Secondary = 1,
     Confirmation = 2,
@@ -1081,6 +1086,7 @@ export enum PaintMode {
     Smooth = 2,
     Roughen = 3,
     Flatten = 4,
+    Elevation = 5,
 }
 
 export enum Plane {
@@ -1474,7 +1480,7 @@ export type ListPaneButtonEntryParams = {
     onClick: (entry: IListPaneButtonEntry) => void;
     title?: LocalizedString;
     tooltip?: BasicTooltipContent;
-    variant?: ButtonPropertyItemVariant;
+    variant?: ButtonVariant;
     icon?: string;
     enabled?: boolean;
     visible?: boolean;
@@ -2183,6 +2189,30 @@ export class BrushShapeManager {
      *
      */
     setDirectionalPlacementMode(directionalPlacementMode: BrushDirectionalPlacementMode): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setElevationBrushRadius(elevationBrushRadius: number): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setElevationFalloff(elevationFalloff: number): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setElevationMode(elevationMode: BrushElevationMode): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setElevationSampleLayers(elevationSampleLayers: number): void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2503,6 +2533,10 @@ export class Cursor {
      * @throws This property can throw when used.
      */
     readonly isVisible: boolean;
+    /**
+     * @throws This property can throw when used.
+     */
+    readonly maxViewBlockDistance: number;
     /**
      * @remarks
      * Get the world position of the 3D block cursor
@@ -3161,7 +3195,7 @@ export class Logger {
      * The message string to send to the log window
      * @throws This function can throw errors.
      */
-    debug(message: string, properties?: LogProperties): void;
+    debug(message: LocalizationEntry | string, properties?: LogProperties): void;
     /**
      * @remarks
      * The error channel is generally used when the editor
@@ -3176,7 +3210,7 @@ export class Logger {
      * The message string to send to the log window
      * @throws This function can throw errors.
      */
-    error(message: string, properties?: LogProperties): void;
+    error(message: LocalizationEntry | string, properties?: LogProperties): void;
     /**
      * @remarks
      * The info channel is intended to communicate general,
@@ -3189,7 +3223,7 @@ export class Logger {
      * The message string to send to the log window
      * @throws This function can throw errors.
      */
-    info(message: string, properties?: LogProperties): void;
+    info(message: LocalizationEntry | string, properties?: LogProperties): void;
     /**
      * @remarks
      * The warning channel is intended to inform the user of
@@ -3203,7 +3237,7 @@ export class Logger {
      * The message string to send to the log window
      * @throws This function can throw errors.
      */
-    warning(message: string, properties?: LogProperties): void;
+    warning(message: LocalizationEntry | string, properties?: LogProperties): void;
 }
 
 /**
@@ -3589,6 +3623,30 @@ export class SelectionManager {
     private constructor();
     readonly entity: SelectionContainerEntity;
     readonly volume: SelectionContainerVolume;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    deselectBlocks(blockIdentifier: string): Promise<number>;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    generateManifest(): Promise<SelectionManifestData>;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    getCurrentManifest(): SelectionManifestData | undefined;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    replaceBlocks(fromBlockIdentifier: string, toBlockIdentifier: string): Promise<number>;
 }
 
 /**
@@ -4147,7 +4205,7 @@ export class Widget {
      */
     addClipboardComponent(
         componentName: string,
-        clipboardItem?: ClipboardItem,
+        clipboardItem?: ClipboardItem | EditorStructure,
         options?: WidgetComponentClipboardOptions,
     ): WidgetComponentClipboard;
     /**
@@ -5627,6 +5685,12 @@ export interface IButtonPropertyItemOptions extends IPropertyItemOptionsBase {
      *
      */
     icon?: string;
+    /**
+     * @remarks
+     * Shrinks button to icon size if button has an icon.
+     *
+     */
+    shrinkToIcon?: boolean;
     /**
      * @remarks
      * Localized title of the property item.
@@ -5644,7 +5708,7 @@ export interface IButtonPropertyItemOptions extends IPropertyItemOptionsBase {
      * The variant for the button. By default it is Primary.
      *
      */
-    variant?: ButtonPropertyItemVariant;
+    variant?: ButtonVariant;
 }
 
 /**
@@ -6159,6 +6223,13 @@ export interface IDropdownPropertyItemOptions extends IPropertyItemOptionsBase {
      *
      */
     hiddenLabel?: boolean;
+    /**
+     * @remarks
+     * Determines how many entries can be displayed before
+     * scrolling is enabled, based on available space.
+     *
+     */
+    maxVisibleEntries?: number;
     /**
      * @remarks
      * This callback is called when UI control value is changed.
@@ -7608,7 +7679,7 @@ export interface IPlayerLogger {
      * @param props
      * Optional player log properties
      */
-    debug(message: string, props?: IPlayerLoggerProperties): void;
+    debug(message: LocalizedString, props?: IPlayerLoggerProperties): void;
     /**
      * @remarks
      * Dispatch a player log message with Error log level
@@ -7618,7 +7689,7 @@ export interface IPlayerLogger {
      * @param props
      * Optional player log properties
      */
-    error(message: string, props?: IPlayerLoggerProperties): void;
+    error(message: LocalizedString, props?: IPlayerLoggerProperties): void;
     /**
      * @remarks
      * Dispatch a player log message with Info log level
@@ -7628,7 +7699,7 @@ export interface IPlayerLogger {
      * @param props
      * Optional player log properties
      */
-    info(message: string, props?: IPlayerLoggerProperties): void;
+    info(message: LocalizedString, props?: IPlayerLoggerProperties): void;
     /**
      * @remarks
      * Dispatch a player log message with Warning log level
@@ -7638,7 +7709,7 @@ export interface IPlayerLogger {
      * @param props
      * Optional player log properties
      */
-    warning(message: string, props?: IPlayerLoggerProperties): void;
+    warning(message: LocalizedString, props?: IPlayerLoggerProperties): void;
 }
 
 /**
@@ -7656,7 +7727,7 @@ export interface IPlayerLoggerProperties {
      * A player log sub message for the toast channel
      *
      */
-    subMessage?: string;
+    subMessage?: LocalizedString;
 }
 
 /**
@@ -8438,6 +8509,14 @@ export interface ITextPropertyItem extends IPropertyItemBase {
      *
      */
     setTitle(title: LocalizedString | undefined): void;
+    /**
+     * @remarks
+     * Updates tooltip description of property item.
+     *
+     * @param tooltip
+     * New tooltip.
+     */
+    setTooltip(tooltip: BasicTooltipContent | undefined): void;
 }
 
 /**
@@ -8465,6 +8544,12 @@ export interface ITextPropertyItemOptions extends IPropertyItemOptionsBase {
      *
      */
     title?: LocalizedString;
+    /**
+     * @remarks
+     * Tooltip description of the property item.
+     *
+     */
+    tooltip?: BasicTooltipContent;
 }
 
 /**
@@ -8527,6 +8612,13 @@ export interface IToggleGroupPropertyItem extends IPropertyItemBase {
  * Properties of toggle group property item list entry
  */
 export interface IToggleGroupPropertyItemEntry {
+    /**
+     * @remarks
+     * Optional enabled state of the entry. If undefined it will be
+     * true.
+     *
+     */
+    readonly enabled?: boolean;
     /**
      * @remarks
      * Optional icon of the dropdown entry.
@@ -8775,6 +8867,11 @@ export interface IVector3PropertyItemOptions extends IPropertyItemOptionsBase {
     tooltip?: BasicTooltipContent;
 }
 
+export interface LocalizationEntry {
+    id: string;
+    props?: string[];
+}
+
 /**
  * A properties class for the global instance of the logger
  * object.
@@ -8804,7 +8901,7 @@ export interface LogProperties {
      * selected.
      *
      */
-    subMessage?: string;
+    subMessage?: LocalizationEntry | string;
     /**
      * @remarks
      * Add additional tags to the log message which can be used by
@@ -8908,6 +9005,20 @@ export interface QuickExtrudeProperties {
     startingLocation?: minecraftserver.Vector3;
 }
 
+export interface SelectionManifestData {
+    entries: SelectionManifestEntry[];
+    generationId: number;
+    inProgress: boolean;
+    processedBlocks: number;
+    progress: number;
+    totalBlocks: number;
+}
+
+export interface SelectionManifestEntry {
+    blockIdentifier: string;
+    count: number;
+}
+
 export interface WeightedBlock {
     block: minecraftserver.BlockType;
     weight: number;

package/package.json

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