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

package/index.d.ts

@@ -33,6 +33,11 @@ export declare enum ActionTypes {
     StatefulAction = 'StatefulAction',
 }
 
+export enum AudioSettingsProperty {
+    AreSoundsMuted = 'AreSoundsMuted',
+    IsMusicMuted = 'IsMusicMuted',
+}
+
 export enum Axis {
     None = 0,
     X = 1,
@@ -1089,6 +1094,13 @@ export declare enum StatusBarAlignment {
     Left = 1,
 }
 
+export enum StructureSource {
+    BehaviorPack = 0,
+    EditorProject = 1,
+    File = 2,
+    Level = 3,
+}
+
 export enum ThemeSettingsColorKey {
     Caret = 'Caret',
     Confirm1 = 'Confirm1',
@@ -1447,6 +1459,7 @@ export type SupportedMouseActionTypes = RegisteredAction<MouseRayCastAction>;
 export declare type TooltipContent = {
     title?: LocalizedString;
     description?: LocalizedString;
+    image?: string;
 };
 
 /**
@@ -1472,6 +1485,26 @@ export declare type TooltipLink = {
 
 export type UnregisterInputBindingCallback = () => void;
 
+export class AudioSettings {
+    private constructor();
+    get(property: AudioSettingsProperty): boolean | number | undefined;
+    getAll(): Record<string, boolean | number>;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    set(property: AudioSettingsProperty, value: boolean | number): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setAll(properties: Record<string, boolean | number>): void;
+}
+
 /**
  * A cache for bedrock event subscriptions. Stores off a
  * subscription by event key, and upon teardown unregisters all
@@ -2262,8 +2295,75 @@ export class EditorConstants {
     readonly minStructureOffset: minecraftserver.Vector3;
 }
 
+export class EditorStructure {
+    private constructor();
+    readonly id: string;
+    readonly isValid: boolean;
+    /**
+     * @throws This property can throw when used.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    readonly size: minecraftserver.Vector3;
+    /**
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    getBlockPermutation(location: minecraftserver.Vector3): minecraftserver.BlockPermutation | undefined;
+    /**
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    getIsWaterlogged(location: minecraftserver.Vector3): boolean;
+    /**
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    getTags(): string[];
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @param waterlogged
+     * Defaults to: false
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftcommon.InvalidArgumentError}
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    setBlockPermutation(
+        location: minecraftserver.Vector3,
+        blockPermutation: minecraftserver.BlockPermutation,
+        waterlogged?: boolean,
+    ): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.InvalidStructureError}
+     */
+    setTags(tags: string[]): void;
+}
+
 export class EditorStructureManager {
     private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    createEmpty(id: string, size: minecraftserver.Vector3): EditorStructure;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2277,21 +2377,21 @@ export class EditorStructureManager {
      *
      * @throws This function can throw errors.
      */
-    getExistingTags(): string[];
+    deleteStructure(id: string): void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
-    loadStructure(location: string, id: string): EditorStructure;
+    getExistingTags(): string[];
     /**
      * @remarks
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
      */
-    saveStructure(structure: EditorStructure): void;
+    getOrCreateStructure(id: string): EditorStructure;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -3056,6 +3156,7 @@ export class SelectionManager {
  */
 export class SettingsManager {
     private constructor();
+    readonly audio: AudioSettings;
     /**
      * @remarks
      * Manages graphics settings properties.
@@ -4459,16 +4560,10 @@ export interface CursorRay {
     start: minecraftserver.Vector3;
 }
 
-export interface EditorStructure {
-    storageLocation: string;
-    structure: minecraftserver.Structure;
-    tags: string[];
-}
-
 export interface EditorStructureSearchOptions {
-    excludeTags?: string[];
+    displayName?: string;
     idPattern?: string;
-    includeLocation?: string[];
+    includeSources?: StructureSource[];
     includeTags?: string[];
 }
 
@@ -4878,7 +4973,7 @@ export interface IBoolPropertyItemOptions extends IPropertyItemOptionsBase {
      * Tooltip description of the property item
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
     /**
      * @remarks
      * Determines how we display bool as a UI element. If
@@ -4986,7 +5081,7 @@ export interface IButtonPropertyItemOptions extends IPropertyItemOptionsBase {
      * Tooltip description of the property item.
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
     /**
      * @remarks
      * The variant for the button. By default it is Primary.
@@ -5296,7 +5391,7 @@ export interface IComboBoxPropertyItemOptions extends IPropertyItemOptionsBase {
      * Tooltip description of the property item.
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
 }
 
 /**
@@ -5492,7 +5587,7 @@ export interface IDropdownPropertyItemOptions extends IPropertyItemOptionsBase {
      * Tooltip description of the property item.
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
 }
 
 /**
@@ -6053,7 +6148,7 @@ export interface INumberPropertyItemOptions extends IPropertyItemOptionsBase {
      * Tooltip description of the property item.
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
     /**
      * @remarks
      * Determines how we display bool as a UI element. If
@@ -7238,7 +7333,7 @@ export interface IToggleGroupPropertyItemOptions extends IPropertyItemOptionsBas
      * Tooltip description of the property item.
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
 }
 
 /**
@@ -7326,7 +7421,7 @@ export interface IVector3PropertyItemOptions extends IPropertyItemOptionsBase {
      * Tooltip description of the property item
      *
      */
-    tooltip?: LocalizedString;
+    tooltip?: BasicTooltipContent;
 }
 
 /**
@@ -7381,7 +7476,7 @@ export interface ModalToolCreationParameters {
      * Tooltip description of the tool
      *
      */
-    tooltip?: string;
+    tooltip?: BasicTooltipContent;
 }
 
 export interface ProjectExportOptions {

package/package.json

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