@minecraft/server-editor 0.1.0-beta.1.21.70-preview.23 → 0.1.0-beta.1.21.70-preview.25

package/index.d.ts

@@ -119,6 +119,7 @@ export declare enum CoreActionBarItemType {
     Export = 'editor:actionBarItem:export',
     Locate = 'editor:actionBarItem:locate',
     Playtest = 'editor:actionBarItem:playtest',
+    Realms = 'editor:actionBarItem:realms',
     Redo = 'editor:actionBarItem:redo',
     Settings = 'editor:actionBarItem:settings',
     Undo = 'editor:actionBarItem:undo',
@@ -1030,6 +1031,7 @@ export declare enum PropertyItemType {
     ButtonPane = 'editorUI:ButtonPane',
     ColorPicker = 'editorUI:ColorPicker',
     ComboBox = 'editorUI:ComboBox',
+    DataTable = 'editorUI:DataTable',
     Divider = 'editorUI:Divider',
     Dropdown = 'editorUI:Dropdown',
     Image = 'editorUI:Image',
@@ -1038,7 +1040,6 @@ export declare enum PropertyItemType {
     ProgressIndicator = 'editorUI:ProgressIndicator',
     String = 'editorUI:String',
     SubPane = 'editorUI:SubPane',
-    Table = 'editorUI:Table',
     Text = 'editorUI:Text',
     ToggleGroup = 'editorUI:ToggleGroup',
     Vector3 = 'editorUI:Vector3',
@@ -1211,13 +1212,6 @@ export type GraphicsSettingsPropertyTypeMap = {
     [GraphicsSettingsProperty.NightVision]?: boolean;
 };
 
-/**
- * A property item which supports BlockList properties
- */
-export type IBlockListPropertyItem<T extends PropertyBag, Prop extends keyof T & string> = IPropertyItem<T, Prop> & {
-    updateBlockList(newBlockList: string[]): void;
-};
-
 /**
  * A property item which supports Dropdown properties
  */
@@ -1276,15 +1270,6 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
     scratchStorage: PerPlayerStorage | undefined;
 };
 
-/**
- * A property item which supports Table properties
- */
-export type ITablePropertyItem<T extends PropertyBag, Prop extends keyof T & string> = IPropertyItem<T, Prop> & {
-    updateCell(dataCell: IPropertyTableCellItem, row: number, column: number): void;
-    updateRow(dataRow: IPropertyTableCellItem[], row: number): void;
-    updateTable(newData: IPropertyTableCellItem[][]): void;
-};
-
 /**
  * A property item which supports Vector3 properties
  */
@@ -1511,6 +1496,14 @@ export declare class BedrockEventSubscriptionCache {
     teardown(): void;
 }
 
+/**
+ * Validates observable objects that support string list as
+ * BlockType
+ */
+export declare class BlockIdentifierListObservableValidator implements ObservableValidator<string[]> {
+    validate(newValue: string[]): string[];
+}
+
 /**
  * Validates observable objects that support string as
  * BlockType
@@ -1518,7 +1511,7 @@ export declare class BedrockEventSubscriptionCache {
 export declare class BlockIdentifierObservableValidator implements ObservableValidator<string> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _defaultValue: string;
@@ -2262,7 +2255,7 @@ export class EditorStructureManager {
 export declare class EntityIdentifierObservableValidator implements ObservableValidator<string> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _defaultValue: string;
@@ -2446,17 +2439,44 @@ export class ExtensionContext {
  */
 export class ExtensionContextAfterEvents {
     private constructor();
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly clipboardChange: ClipboardChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly currentThemeChange: CurrentThemeChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly currentThemeColorChange: CurrentThemeColorChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly cursorPropertyChange: CursorPropertyChangeAfterEventSignal;
     /**
      * @remarks
      * This event triggers when the editor mode changes for the
      * player.
      *
+     * This property can be read in early-execution mode.
+     *
      */
     readonly modeChange: ModeChangeAfterEventSignal;
+    /**
+     * @remarks
+     * This property can be read in early-execution mode.
+     *
+     */
     readonly primarySelectionChange: PrimarySelectionChangeAfterEventSignal;
 }
 
@@ -2489,6 +2509,8 @@ export class GraphicsSettings {
      * @remarks
      * Modifies a graphics settings property value.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param property
      * Property identifier.
      * @param value
@@ -2500,6 +2522,8 @@ export class GraphicsSettings {
      * @remarks
      * Modify multiple graphics settings properties.
      *
+     * This function can't be called in read-only mode.
+     *
      * @param properties
      * Property map to set available property values. If the
      * property is not defined in the map, it will not be modified.
@@ -2672,19 +2696,19 @@ export class ModeChangeAfterEventSignal {
 export declare class NumberLimitObservableValidator implements ObservableValidator<number> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _isInteger?: boolean;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _max?: number;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _min?: number;
@@ -3127,10 +3151,16 @@ export class SpeedSettings {
     get<T extends keyof SpeedSettingsPropertyTypeMap>(property: T): SpeedSettingsPropertyTypeMap[T] | undefined;
     getAll(): SpeedSettingsPropertyTypeMap;
     /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     set<T extends keyof SpeedSettingsPropertyTypeMap>(property: T, value: SpeedSettingsPropertyTypeMap[T]): void;
     /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     setAll(properties: SpeedSettingsPropertyTypeMap): void;
@@ -3487,19 +3517,19 @@ export class UserDefinedTransactionHandlerId {
 export declare class Vector3LimitObservableValidator implements ObservableValidator<minecraftserver.Vector3> {
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _isInteger?: boolean;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _max: Partial<minecraftserver.Vector3>;
     /**
      * @remarks
-     * This property can't be edited in read-only mode.
+     * This property can't be used in read-only mode.
      *
      */
     protected _min: Partial<minecraftserver.Vector3>;
@@ -4536,6 +4566,32 @@ export interface IActionBarItemCreationParams {
     tooltipTitle?: string;
 }
 
+/**
+ * A property item which supports block list properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IBlockListPropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Current value of the property item.
+     *
+     */
+    readonly value: ReadonlyArray<string>;
+}
+
+/**
+ * Optional properties for Bool property item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IBlockListPropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * This callback is called when UI control value is changed.
+     *
+     */
+    onChange?: (newValue: ReadonlyArray<string>, oldValue: ReadonlyArray<string>) => void;
+}
+
 /**
  * Block Table Entry info for block table property item
  */
@@ -4637,7 +4693,7 @@ export interface IBlockTablePropertyItemOptions extends IPropertyItemOptionsBase
 }
 
 /**
- * A property item which supports Vector3 properties
+ * A property item which supports boolean properties
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IBoolPropertyItem extends IPropertyItemBase {
@@ -4973,6 +5029,71 @@ export interface IComboBoxPropertyItemOptions extends IPropertyItemOptionsBase {
     tooltip?: LocalizedString;
 }
 
+/**
+ * A property item which supports data entries displayed in a
+ * table
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IDataTablePropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Update table entries
+     *
+     * @param data
+     * New data entries.
+     */
+    updateEntries(data: IDataTablePropertyItemEntry[][]): void;
+    /**
+     * @remarks
+     * Update table cell entry
+     *
+     * @param data
+     * New data entry.
+     * @param row
+     * Cell row index.
+     * @param column
+     * Cell column index.
+     */
+    updateEntry(data: IDataTablePropertyItemEntry, row: number, column: number): void;
+    /**
+     * @remarks
+     * Update table row entries
+     *
+     * @param data
+     * New data entries.
+     * @param row
+     * Cell row index.
+     */
+    updateRow(data: IDataTablePropertyItemEntry[], row: number): void;
+}
+
+/**
+ * Properties of data table property item menu entry
+ */
+export interface IDataTablePropertyItemEntry {
+    image?: ImageResourceData;
+    text?: LocalizedString;
+}
+
+/**
+ * Properties of data table item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IDataTablePropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * List of default data table entries
+     *
+     */
+    entries?: IDataTablePropertyItemEntry[][];
+    /**
+     * @remarks
+     * Localized title of the property item.
+     *
+     */
+    title?: LocalizedString;
+}
+
 /**
  * Simple abstraction for disposable objects.
  */
@@ -5830,11 +5951,6 @@ export interface IPropertyItemOptionsBase {
     visible?: boolean;
 }
 
-// @ts-ignore Class inheritance allowed for native defined classes
-export interface IPropertyItemOptionsBlockList extends IPropertyItemOptions {
-    blockList: string[];
-}
-
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IPropertyItemOptionsBool extends IPropertyItemOptions {
     /**
@@ -5900,12 +6016,6 @@ export interface IPropertyItemOptionsSubPane extends IPropertyItemOptions {
     pane: IPropertyPane;
 }
 
-// @ts-ignore Class inheritance allowed for native defined classes
-export interface IPropertyItemOptionsTable extends IPropertyItemOptions {
-    defaultData: IPropertyTableCellItem[][];
-    titleId?: string;
-}
-
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IPropertyItemOptionsVector3 extends IPropertyItemOptions {
     /**
@@ -5976,12 +6086,7 @@ export interface IPropertyPane extends IPane {
      * Adds a block list to the pane.
      *
      */
-    addBlockList(options?: IPropertyItemOptionsBlockList): IBlockListPropertyItem<
-        {
-            EMPTY: undefined;
-        },
-        'EMPTY'
-    >;
+    addBlockList(value: IObservableProp<string[]>, options?: IBlockListPropertyItemOptions): IBlockListPropertyItem;
     /**
      * @remarks
      * Adds a block table to the pane.
@@ -6045,6 +6150,12 @@ export interface IPropertyPane extends IPane {
      *
      */
     addComboBox(value: IObservableProp<string>, options?: IComboBoxPropertyItemOptions): IComboBoxPropertyItem;
+    /**
+     * @remarks
+     * Adds a data table to the pane.
+     *
+     */
+    addDataTable(options?: IDataTablePropertyItemOptions): IDataTablePropertyItem;
     /**
      * @remarks
      * Adds an divider item to the pane.
@@ -6125,17 +6236,6 @@ export interface IPropertyPane extends IPane {
         property: Prop,
         options?: IPropertyItemOptions,
     ): IPropertyItem<T, Prop>;
-    /**
-     * @remarks
-     * Adds a table to the pane.
-     *
-     */
-    addTable(options?: IPropertyItemOptionsTable): ITablePropertyItem<
-        {
-            EMPTY: undefined;
-        },
-        'EMPTY'
-    >;
     /**
      * @remarks
      * Adds a multiline Text item to the pane.
@@ -6214,12 +6314,6 @@ export interface IPropertyPaneOptions {
     title?: LocalizedString;
 }
 
-export interface IPropertyTableCellItem {
-    block?: string;
-    icon?: string;
-    text?: string;
-}
-
 /**
  * Key binding that is registered to an input context
  */

package/package.json

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