@minecraft/server-editor 0.1.0-beta.1.21.60-preview.28 → 0.1.0-beta.1.21.70-preview.20

package/index.d.ts

@@ -850,6 +850,31 @@ export declare enum KeyboardKey {
     QUOTE = 222,
 }
 
+/**
+ * Determines how key binding should be processed to fire
+ * actions
+ */
+export declare enum KeyProcessingState {
+    /**
+     * @remarks
+     * Consume key input event and prevent propagation
+     *
+     */
+    Consume = 0,
+    /**
+     * @remarks
+     * Pass key input event to parent context after processing it
+     *
+     */
+    Passthrough = 1,
+    /**
+     * @remarks
+     * Skip key input event processing
+     *
+     */
+    Disabled = 2,
+}
+
 /**
  * Alignment options for UI elements
  */
@@ -972,6 +997,14 @@ export enum PrimitiveType {
     AxialSphere = 5,
 }
 
+/**
+ * The possible variants of a ProgressIndicator property item.
+ */
+export declare enum ProgressIndicatorPropertyItemVariant {
+    Spinner = 0,
+    ProgressBar = 1,
+}
+
 export enum ProjectExportType {
     PlayableWorld = 0,
     ProjectBackup = 1,
@@ -991,7 +1024,9 @@ export declare enum PropertyItemType {
     Divider = 'editorUI:Divider',
     Dropdown = 'editorUI:Dropdown',
     Image = 'editorUI:Image',
+    Link = 'editorUI:Link',
     Number = 'editorUI:Number',
+    ProgressIndicator = 'editorUI:ProgressIndicator',
     String = 'editorUI:String',
     SubPane = 'editorUI:SubPane',
     Table = 'editorUI:Table',
@@ -1179,6 +1214,16 @@ export type IDropdownPropertyItem_deprecated<
     Prop extends keyof T & string,
 > = IPropertyItem<T, Prop> & IDropdownPropertyItemMixIn;
 
+/**
+ * Animation properties for a horizontally laid out sprite
+ * sheet image
+ */
+export declare type ImageAnimationData = {
+    frames: number;
+    duration?: number;
+    delay?: number;
+};
+
 export declare type ImageResourceData = {
     path: string;
     type: ImageResourceType;
@@ -4415,6 +4460,12 @@ export interface IActionBarItemCreationParams {
      *
      */
     icon: string;
+    /**
+     * @remarks
+     * Animation data for sprite sheet icon image
+     *
+     */
+    iconAnimation?: ImageAnimationData;
     /**
      * @remarks
      * Text label for item.
@@ -5024,7 +5075,7 @@ export interface IGlobalInputManager {
         action: SupportedKeyboardActionTypes,
         binding: KeyBinding,
         info?: KeyBindingInfo,
-    ): void;
+    ): IRegisteredKeyBinding;
 }
 
 /**
@@ -5093,6 +5144,56 @@ export interface IImagePropertyItemOptions extends IPropertyItemOptionsBase {
     onClick?: (x: number, y: number) => void;
 }
 
+/**
+ * A property item which supports Link properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface ILinkPropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Current value of the property item.
+     *
+     */
+    readonly value: Readonly<string>;
+    /**
+     * @remarks
+     * Sets title of the property item.
+     *
+     */
+    setTitle(title: LocalizedString | undefined): void;
+    /**
+     * @remarks
+     * Sets tooltip description of the property item.
+     *
+     */
+    setTooltip(tooltip: LocalizedString | undefined): void;
+}
+
+/**
+ * Optional properties for Link property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface ILinkPropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * Hides the link icon. If undefined, it will default to false.
+     *
+     */
+    hideIcon?: boolean;
+    /**
+     * @remarks
+     * Localized title of the text item.
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Tooltip description of the property item
+     *
+     */
+    tooltip?: LocalizedString;
+}
+
 export interface IMenu {
     /**
      * @remarks
@@ -5193,7 +5294,11 @@ export interface IModalTool {
      */
     onModalToolActivation: EventSink<ModalToolLifecycleEventPayload>;
     bindPropertyPane(pane: IRootPropertyPane): void;
-    registerKeyBinding(action: SupportedKeyboardActionTypes, binding: KeyBinding, info?: KeyBindingInfo): void;
+    registerKeyBinding(
+        action: SupportedKeyboardActionTypes,
+        binding: KeyBinding,
+        info?: KeyBindingInfo,
+    ): IRegisteredKeyBinding;
     registerMouseButtonBinding(action: SupportedMouseActionTypes): void;
     registerMouseDragBinding(action: SupportedMouseActionTypes): void;
     registerMouseWheelBinding(action: SupportedMouseActionTypes): void;
@@ -5375,6 +5480,74 @@ export interface IPlayerLogger {
     warning(message: string): void;
 }
 
+/**
+ * A property item which supports ProgressIndicator properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IProgressIndicatorPropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Current progress of the property item.
+     *
+     */
+    readonly progress: Readonly<number> | undefined;
+    /**
+     * @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: LocalizedString | undefined): void;
+}
+
+/**
+ * Optional properties for progress indicator property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IProgressIndicatorPropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * If true label text will be hidden. If undefined, the label
+     * will be visible by default.
+     *
+     */
+    hiddenLabel?: boolean;
+    /**
+     * @remarks
+     * Normalized loading progress (0 to 1).
+     *
+     */
+    progress?: IObservableProp<number>;
+    /**
+     * @remarks
+     * Localized title of the property item.
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Tooltip description of the property item.
+     *
+     */
+    tooltip?: LocalizedString;
+    /**
+     * @remarks
+     * Determines how we display progress indicator. If undefined,
+     * it will default to Spinner.
+     *
+     */
+    variant?: ProgressIndicatorPropertyItemVariant;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IPropertyItem<T extends PropertyBag, Prop extends keyof T & string> extends IPropertyItemBase {
     /**
@@ -5735,6 +5908,12 @@ export interface IPropertyPane {
         value: IObservableProp<string | ImageResourceData>,
         options?: IImagePropertyItemOptions,
     ): IImagePropertyItem;
+    /**
+     * @remarks
+     * Adds a multiline Text item to the pane.
+     *
+     */
+    addLink(value: IObservableProp<string>, options?: ILinkPropertyItemOptions): ILinkPropertyItem;
     /**
      * @remarks
      * Adds a number item to the pane.
@@ -5751,6 +5930,12 @@ export interface IPropertyPane {
         property: Prop,
         options?: IPropertyItemOptionsNumber,
     ): IPropertyItem<T, Prop>;
+    /**
+     * @remarks
+     * Adds a Progress Indicator item to the pane.
+     *
+     */
+    addProgressIndicator(options?: IProgressIndicatorPropertyItemOptions): IProgressIndicatorPropertyItem;
     /**
      * @remarks
      */
@@ -5878,6 +6063,33 @@ export interface IPropertyTableCellItem {
     text?: string;
 }
 
+/**
+ * Key binding that is registered to an input context
+ */
+export interface IRegisteredKeyBinding {
+    /**
+     * @remarks
+     * Unique identifier for the binding.
+     *
+     */
+    readonly id: string;
+    /**
+     * @remarks
+     * Returns current processing state of the binding.
+     *
+     */
+    getProcessingState(): KeyProcessingState;
+    /**
+     * @remarks
+     * Updates how the key input will be processed for this
+     * binding. If undefined, it will be consumed.
+     *
+     * @param newState
+     * New binding processing state.
+     */
+    setProcessingState(newState: KeyProcessingState | undefined): void;
+}
+
 /**
  * Optional parameter definition for RegisterEditorExtension
  * function Allows the extension registrar to specify optional
@@ -6669,7 +6881,7 @@ export interface ISubPanePropertyItemOptions extends IPropertyPaneOptions {
 }
 
 /**
- * A property item which supports Vector3 properties
+ * A property item which supports Text properties
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface ITextPropertyItem extends IPropertyItemBase {
@@ -7152,7 +7364,8 @@ export declare function executeLargeOperationFromIterator(
 /**
  * @remarks
  * Returns a string array of the default block types for editor
- * operations. Can be used to further filter blocks.
+ * operations. Can be used to further filter blocks. This will
+ * throw if called in early execution.
  *
  * @returns
  * Default allowed block list

package/package.json

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

package/.eslintrc.json

@@ -1,23 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-    ],
-    "overrides": [
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "@typescript-eslint/no-explicit-any": "off"
-    }
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-      "module": "commonjs",
-      "lib": ["es6"],
-      "target": "es6",
-      "forceConsistentCasingInFileNames": true,
-      "noEmit": true,
-      "noImplicitAny": true,
-      "noImplicitThis": true,
-      "strictFunctionTypes": true,
-      "strictNullChecks": true,
-      "baseUrl": "../",
-      "typeRoots": ["../"],
-      "types": []
-  },
-  "files": [
-      "index.d.ts",
-      "tests.ts"
-  ]
-}