@minecraft/server-editor 0.1.0-beta.1.26.10-preview.27 → 0.1.0-beta.1.26.20-preview.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +146 -34
  2. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -1240,6 +1240,14 @@ export declare enum PropertyItemType {
1240
1240
  Vector3Timeline = 'editorUI:Vector3Timeline',
1241
1241
  }
1242
1242
 
1243
+ /**
1244
+ * Determines the location root pane will be displayed in
1245
+ */
1246
+ export declare enum RootPaneLocation {
1247
+ Drawer = 0,
1248
+ Viewport = 1,
1249
+ }
1250
+
1243
1251
  export enum SelectionVolumeEventType {
1244
1252
  Set = 1,
1245
1253
  Add = 2,
@@ -1528,6 +1536,7 @@ export type ICollectionTreeEntryOptions = {
1528
1536
  color?: minecraftserver.RGBA;
1529
1537
  userData?: unknown;
1530
1538
  onSelectedChange?: (selected: boolean, folder: ICollectionTreeEntry) => void;
1539
+ onBeforeRelocated?: (toFolder: ICollectionTreeFolder, toIndex: number, entry: ICollectionTreeEntry) => boolean;
1531
1540
  };
1532
1541
 
1533
1542
  /**
@@ -2312,6 +2321,7 @@ export declare abstract class BrushShape {
2312
2321
  abstract createSettingsPane(
2313
2322
  parentPane: IPropertyPane,
2314
2323
  onSettingsChange?: () => void,
2324
+ flatLayout?: boolean,
2315
2325
  ): ISubPanePropertyItem | undefined;
2316
2326
  abstract createShape(): RelativeVolumeListBlockVolume;
2317
2327
  /**
@@ -2692,7 +2702,11 @@ export declare class ConeBrushShape extends BrushShape {
2692
2702
  });
2693
2703
  applySetting(brushSettings: ConeBrushShapeSettings): void;
2694
2704
  calculateBounds(): minecraftserver.BlockBoundingBox;
2695
- createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2705
+ createSettingsPane(
2706
+ parentPane: IPropertyPane,
2707
+ onSettingsChange?: () => void,
2708
+ flatLayout?: boolean,
2709
+ ): ISubPanePropertyItem;
2696
2710
  createShape(): RelativeVolumeListBlockVolume;
2697
2711
  createShapeAsync(
2698
2712
  cancelToken?: {
@@ -2729,7 +2743,11 @@ export declare class CuboidBrushShape extends BrushShape {
2729
2743
  });
2730
2744
  applySetting(brushSettings: CuboidBrushShapeSettings): void;
2731
2745
  calculateBounds(): minecraftserver.BlockBoundingBox;
2732
- createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2746
+ createSettingsPane(
2747
+ parentPane: IPropertyPane,
2748
+ onSettingsChange?: () => void,
2749
+ flatLayout?: boolean,
2750
+ ): ISubPanePropertyItem;
2733
2751
  createShape(): RelativeVolumeListBlockVolume;
2734
2752
  createShapeAsync(
2735
2753
  cancelToken?: {
@@ -3016,7 +3034,11 @@ export declare class CylinderBrushShape extends BrushShape {
3016
3034
  });
3017
3035
  applySetting(brushSettings: CylinderBrushShapeSettings): void;
3018
3036
  calculateBounds(): minecraftserver.BlockBoundingBox;
3019
- createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
3037
+ createSettingsPane(
3038
+ parentPane: IPropertyPane,
3039
+ onSettingsChange?: () => void,
3040
+ flatLayout?: boolean,
3041
+ ): ISubPanePropertyItem;
3020
3042
  createShape(): RelativeVolumeListBlockVolume;
3021
3043
  createShapeAsync(
3022
3044
  cancelToken?: {
@@ -3221,7 +3243,11 @@ export declare class EllipsoidBrushShape extends BrushShape {
3221
3243
  });
3222
3244
  applySetting(brushSettings: EllipsoidBrushShapeSettings): void;
3223
3245
  calculateBounds(): minecraftserver.BlockBoundingBox;
3224
- createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
3246
+ createSettingsPane(
3247
+ parentPane: IPropertyPane,
3248
+ onSettingsChange?: () => void,
3249
+ flatLayout?: boolean,
3250
+ ): ISubPanePropertyItem;
3225
3251
  createShape(): RelativeVolumeListBlockVolume;
3226
3252
  createShapeAsync(
3227
3253
  cancelToken?: {
@@ -3929,7 +3955,11 @@ export declare class PyramidBrushShape extends BrushShape {
3929
3955
  });
3930
3956
  applySetting(brushSettings: PyramidBrushShapeSettings): void;
3931
3957
  calculateBounds(): minecraftserver.BlockBoundingBox;
3932
- createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
3958
+ createSettingsPane(
3959
+ parentPane: IPropertyPane,
3960
+ onSettingsChange?: () => void,
3961
+ flatLayout?: boolean,
3962
+ ): ISubPanePropertyItem;
3933
3963
  createShape(): RelativeVolumeListBlockVolume;
3934
3964
  createShapeAsync(
3935
3965
  cancelToken?: {
@@ -6881,6 +6911,14 @@ export interface ICollectionTreeFolder {
6881
6911
  * Index of the entry
6882
6912
  */
6883
6913
  removeEntryByIndex(index: number): boolean;
6914
+ /**
6915
+ * @remarks
6916
+ * Removes the folder with the id if it exists at the root
6917
+ *
6918
+ * @param id
6919
+ * Identifier of the folder
6920
+ */
6921
+ removeFolder(id: string): boolean;
6884
6922
  /**
6885
6923
  * @remarks
6886
6924
  * Set color of the entry.
@@ -6903,6 +6941,14 @@ export interface ICollectionTreeFolder {
6903
6941
  *
6904
6942
  */
6905
6943
  setHeaderAction(actionParams: ICollectionTreeFolderHeaderActionParams | undefined): void;
6944
+ /**
6945
+ * @remarks
6946
+ * Updates menu items for the folder
6947
+ *
6948
+ * @param menu
6949
+ * New menu items
6950
+ */
6951
+ setMenu(menu: IMenuCreationParams[] | undefined): void;
6906
6952
  /**
6907
6953
  * @remarks
6908
6954
  * Set selected state of the entry.
@@ -6927,12 +6973,24 @@ export interface ICollectionTreeFolder {
6927
6973
  */
6928
6974
  // @ts-ignore Class inheritance allowed for native defined classes
6929
6975
  export interface ICollectionTreePropertyItem extends IPropertyItemBase {
6976
+ /**
6977
+ * @remarks
6978
+ * Drag and drop support for the entries
6979
+ *
6980
+ */
6981
+ readonly canDragDropEntries: boolean;
6930
6982
  /**
6931
6983
  * @remarks
6932
6984
  * Count of the child folders
6933
6985
  *
6934
6986
  */
6935
6987
  readonly folderCount: number;
6988
+ /**
6989
+ * @remarks
6990
+ * View control pane for the collection tree
6991
+ *
6992
+ */
6993
+ readonly viewControlPane: IListViewControlPane | undefined;
6936
6994
  /**
6937
6995
  * @remarks
6938
6996
  * Sort type for the folders.
@@ -6947,6 +7005,14 @@ export interface ICollectionTreePropertyItem extends IPropertyItemBase {
6947
7005
  * Options to create a folder
6948
7006
  */
6949
7007
  addFolder(options: ICollectionTreeFolderOptions): ICollectionTreeFolder;
7008
+ /**
7009
+ * @remarks
7010
+ * Creates a pane that displays view and filtering
7011
+ * configurations for the collection tree if the parent
7012
+ * container supports it.
7013
+ *
7014
+ */
7015
+ buildViewControl(options: ICollectionTreeViewControlPaneOptions): IListViewControlPane;
6950
7016
  /**
6951
7017
  * @remarks
6952
7018
  * Iterates over the first layer of folders
@@ -6963,6 +7029,22 @@ export interface ICollectionTreePropertyItem extends IPropertyItemBase {
6963
7029
  * Identifier of the folder
6964
7030
  */
6965
7031
  getFolder(id: string): ICollectionTreeFolder | undefined;
7032
+ /**
7033
+ * @remarks
7034
+ * Removes the folder with the id if it exists at the root
7035
+ *
7036
+ * @param id
7037
+ * Identifier of the folder
7038
+ */
7039
+ removeFolder(id: string): boolean;
7040
+ /**
7041
+ * @remarks
7042
+ * Toggles drag and drop support for the entries
7043
+ *
7044
+ * @param enabled
7045
+ * Whether to enable drag and drop
7046
+ */
7047
+ setCanDragDropEntries(enabled: boolean): void;
6966
7048
  /**
6967
7049
  * @remarks
6968
7050
  * Updates the folder sort type for the whole view
@@ -6978,6 +7060,12 @@ export interface ICollectionTreePropertyItem extends IPropertyItemBase {
6978
7060
  */
6979
7061
  // @ts-ignore Class inheritance allowed for native defined classes
6980
7062
  export interface ICollectionTreePropertyItemOptions extends IPropertyItemOptionsBase {
7063
+ /**
7064
+ * @remarks
7065
+ * Setting true will enable drag and drop support for entries.
7066
+ *
7067
+ */
7068
+ canDragDropEntries?: boolean;
6981
7069
  /**
6982
7070
  * @remarks
6983
7071
  * Localized title of the property item.
@@ -6992,6 +7080,24 @@ export interface ICollectionTreePropertyItemOptions extends IPropertyItemOptions
6992
7080
  viewSortType?: CollectionTreeSortType;
6993
7081
  }
6994
7082
 
7083
+ // @ts-ignore Class inheritance allowed for native defined classes
7084
+ export interface ICollectionTreeViewControlPaneOptions extends IListViewControlPaneOptions {
7085
+ /**
7086
+ * @remarks
7087
+ * This function will be called whenever the filter is changed
7088
+ * by the user
7089
+ *
7090
+ */
7091
+ onFilterChanged?: (visibleFolders: string[]) => void;
7092
+ /**
7093
+ * @remarks
7094
+ * Custom sort options. If undefined, collection tree sort
7095
+ * options will be used.
7096
+ *
7097
+ */
7098
+ sortOptions?: CollectionTreeSortType[];
7099
+ }
7100
+
6995
7101
  /**
6996
7102
  * A property item which supports Color Picker properties
6997
7103
  */
@@ -7852,7 +7958,7 @@ export interface IListPanePropertyItem extends IPropertyItemBase, IPane {
7852
7958
  * View control pane for the list
7853
7959
  *
7854
7960
  */
7855
- readonly viewControlPane: IListPaneViewControlPane | undefined;
7961
+ readonly viewControlPane: IListViewControlPane | undefined;
7856
7962
  /**
7857
7963
  * @remarks
7858
7964
  * Current sorting type for the pane slots
@@ -7872,7 +7978,7 @@ export interface IListPanePropertyItem extends IPropertyItemBase, IPane {
7872
7978
  * it.
7873
7979
  *
7874
7980
  */
7875
- buildViewControl(options: IListPaneViewControlPaneOptions): IListPaneViewControlPane;
7981
+ buildViewControl(options: IListPaneViewControlPaneOptions): IListViewControlPane;
7876
7982
  /**
7877
7983
  * @remarks
7878
7984
  * Finds the slot with the identifier.
@@ -8150,11 +8256,32 @@ export interface IListPaneTextEntry extends IListPaneEntry {
8150
8256
  setValue(value: LocalizedString): void;
8151
8257
  }
8152
8258
 
8153
- /**
8154
- * View control for a list pane to manage how slots are
8155
- * displayed
8156
- */
8157
- export interface IListPaneViewControlPane {
8259
+ // @ts-ignore Class inheritance allowed for native defined classes
8260
+ export interface IListPaneViewControlPaneOptions extends IListViewControlPaneOptions {
8261
+ /**
8262
+ * @remarks
8263
+ * Flags to determine visible filters. If undefined it will be
8264
+ * All.
8265
+ *
8266
+ */
8267
+ filterFlags?: ListViewControlFilterFlags;
8268
+ /**
8269
+ * @remarks
8270
+ * This function will be called whenever the filter is changed
8271
+ * by the user
8272
+ *
8273
+ */
8274
+ onFilterChanged?: (visibleSlotIds: string[]) => void;
8275
+ /**
8276
+ * @remarks
8277
+ * Custom sort options. If undefined, list pane sort options
8278
+ * will be used.
8279
+ *
8280
+ */
8281
+ sortOptions?: ListPaneViewSortType[];
8282
+ }
8283
+
8284
+ export interface IListViewControlPane {
8158
8285
  /**
8159
8286
  * @remarks
8160
8287
  * Unique identifier
@@ -8219,40 +8346,19 @@ export interface IListPaneViewControlPane {
8219
8346
  updateActionState(id: string, newState: ListViewControlActionState): void;
8220
8347
  }
8221
8348
 
8222
- export interface IListPaneViewControlPaneOptions {
8349
+ export interface IListViewControlPaneOptions {
8223
8350
  /**
8224
8351
  * @remarks
8225
8352
  * Default actions
8226
8353
  *
8227
8354
  */
8228
8355
  actions?: ListViewControlAction[];
8229
- /**
8230
- * @remarks
8231
- * Flags to determine visible filters. If undefined it will be
8232
- * All.
8233
- *
8234
- */
8235
- filterFlags?: ListViewControlFilterFlags;
8236
8356
  /**
8237
8357
  * @remarks
8238
8358
  * This function will be called whenever user clicks an action
8239
8359
  *
8240
8360
  */
8241
8361
  onActionClicked?: (id: string) => void;
8242
- /**
8243
- * @remarks
8244
- * This function will be called whenever the filter is changed
8245
- * by the user
8246
- *
8247
- */
8248
- onFilterChanged?: (visibleSlotIds: string[]) => void;
8249
- /**
8250
- * @remarks
8251
- * Custom sort options. If undefined, list pane sort options
8252
- * will be used.
8253
- *
8254
- */
8255
- sortOptions?: ListPaneViewSortType[];
8256
8362
  /**
8257
8363
  * @remarks
8258
8364
  * Initial visibility state. It undefined, it will be false.
@@ -9849,6 +9955,12 @@ export interface IRootPropertyPaneOptions extends IPropertyPaneOptions {
9849
9955
  *
9850
9956
  */
9851
9957
  icon?: string;
9958
+ /**
9959
+ * @remarks
9960
+ * Determines how root pane will be displayed in the UI.
9961
+ *
9962
+ */
9963
+ location?: RootPaneLocation;
9852
9964
  }
9853
9965
 
9854
9966
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-editor",
3
- "version": "0.1.0-beta.1.26.10-preview.27",
3
+ "version": "0.1.0-beta.1.26.20-preview.20",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {
@@ -14,8 +14,8 @@
14
14
  ],
15
15
  "peerDependencies": {
16
16
  "@minecraft/common": "^1.0.0",
17
- "@minecraft/server": "^2.7.0-beta.1.26.10-preview.27",
18
- "@minecraft/vanilla-data": ">=1.20.70 || 1.26.10-preview.27"
17
+ "@minecraft/server": "^2.8.0-beta.1.26.20-preview.20",
18
+ "@minecraft/vanilla-data": ">=1.20.70 || 1.26.20-preview.20"
19
19
  },
20
20
  "license": "MIT"
21
21
  }