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

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 +129 -0
  2. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -1255,6 +1255,7 @@ export declare enum PropertyItemType {
1255
1255
  export declare enum RootPaneLocation {
1256
1256
  Drawer = 0,
1257
1257
  Viewport = 1,
1258
+ Bottom = 2,
1258
1259
  }
1259
1260
 
1260
1261
  export enum SelectionVolumeEventType {
@@ -1628,11 +1629,13 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
1628
1629
  createPropertyPane(options: IRootPropertyPaneOptions): IRootPropertyPane;
1629
1630
  readonly actionManager: ActionManager;
1630
1631
  readonly inputManager: IGlobalInputManager;
1632
+ readonly paneManager: IPaneManager;
1631
1633
  readonly menuBar: IMenuContainer;
1632
1634
  readonly actionBar: IActionBar;
1633
1635
  readonly statusBar: IStatusBar;
1634
1636
  readonly dialogManager: IModalDialogManager;
1635
1637
  readonly toolRail: IModalToolContainer;
1638
+ readonly badgeManager: IContentBadgeManager;
1636
1639
  readonly log: IPlayerLogger;
1637
1640
  readonly extensionContext: ExtensionContext;
1638
1641
  readonly builtInUIManager: BuiltInUIManager;
@@ -6400,6 +6403,12 @@ export interface IActionBarItem {
6400
6403
  * Properties required to create an Action Bar item.
6401
6404
  */
6402
6405
  export interface IActionBarItemCreationParams {
6406
+ /**
6407
+ * @remarks
6408
+ * Optional content badge identifier associated with the item.
6409
+ *
6410
+ */
6411
+ contentBadgeId?: string;
6403
6412
  /**
6404
6413
  * @remarks
6405
6414
  * Initial enabled state of the item. If not defined, default
@@ -7584,6 +7593,27 @@ export interface IComboBoxPropertyItemOptions extends IPropertyItemOptionsBase {
7584
7593
  tooltip?: BasicTooltipContent;
7585
7594
  }
7586
7595
 
7596
+ export interface IContentBadgeManager {
7597
+ /**
7598
+ * @remarks
7599
+ * Register a badge to highlight a content.
7600
+ *
7601
+ * @param id
7602
+ * The badge identifier
7603
+ * @param iteration
7604
+ * The iteration number (default: 0)
7605
+ */
7606
+ registerBadge(id: string, iteration?: number): void;
7607
+ /**
7608
+ * @remarks
7609
+ * Unregister a badge.
7610
+ *
7611
+ * @param id
7612
+ * The badge identifier to unregister
7613
+ */
7614
+ unregisterBadge(id: string): void;
7615
+ }
7616
+
7587
7617
  /**
7588
7618
  * A property item which supports data entries displayed in a
7589
7619
  * table
@@ -7895,6 +7925,38 @@ export interface IImagePropertyItemOptions extends IPropertyItemOptionsBase {
7895
7925
  onClick?: (x: number, y: number) => void;
7896
7926
  }
7897
7927
 
7928
+ /**
7929
+ * A root pane that can store property items.
7930
+ */
7931
+ // @ts-ignore Class inheritance allowed for native defined classes
7932
+ export interface IIntroductionPane extends IPane {
7933
+ /**
7934
+ * @remarks
7935
+ * Adds a new tab to the introduction pane
7936
+ *
7937
+ */
7938
+ addTab(props: IntroductionPaneTabProps): IPropertyPane;
7939
+ }
7940
+
7941
+ /**
7942
+ * The options to create introduction pane.
7943
+ */
7944
+ // @ts-ignore Class inheritance allowed for native defined classes
7945
+ export interface IIntroductionPaneOptions extends IPropertyPaneOptions {
7946
+ /**
7947
+ * @remarks
7948
+ * Localized title of the property pane
7949
+ *
7950
+ */
7951
+ title?: LocalizedString;
7952
+ /**
7953
+ * @remarks
7954
+ * Unique identifier for the pane
7955
+ *
7956
+ */
7957
+ uniqueId?: string;
7958
+ }
7959
+
7898
7960
  /**
7899
7961
  * A property item which supports Link properties
7900
7962
  */
@@ -8634,6 +8696,12 @@ export interface IMenuCreationParams {
8634
8696
  *
8635
8697
  */
8636
8698
  label: string;
8699
+ /**
8700
+ * @remarks
8701
+ * Determines the order of the menu item among its siblings.
8702
+ *
8703
+ */
8704
+ sortIndex?: number;
8637
8705
  /**
8638
8706
  * @remarks
8639
8707
  * Whether the menu should have a tooltip.
@@ -9204,6 +9272,42 @@ export interface IModalToolContainer {
9204
9272
  setSortOrder(ids: string[] | undefined): void;
9205
9273
  }
9206
9274
 
9275
+ /**
9276
+ * Properties for introduction pane tab.
9277
+ */
9278
+ export interface IntroductionPaneTabProps {
9279
+ /**
9280
+ * @remarks
9281
+ * Optional header for the tab content
9282
+ *
9283
+ */
9284
+ contentHeader?: LocalizedString;
9285
+ /**
9286
+ * @remarks
9287
+ * Optional image for the tab content
9288
+ *
9289
+ */
9290
+ contentImage?: string;
9291
+ /**
9292
+ * @remarks
9293
+ * Icon for the tab
9294
+ *
9295
+ */
9296
+ icon?: string;
9297
+ /**
9298
+ * @remarks
9299
+ * Unique identifier for the tab
9300
+ *
9301
+ */
9302
+ id: string;
9303
+ /**
9304
+ * @remarks
9305
+ * Localized title of the tab
9306
+ *
9307
+ */
9308
+ label: LocalizedString;
9309
+ }
9310
+
9207
9311
  /**
9208
9312
  * A property item which supports Number properties
9209
9313
  */
@@ -9533,6 +9637,24 @@ export interface IPane {
9533
9637
  show(): void;
9534
9638
  }
9535
9639
 
9640
+ /**
9641
+ * Manager for creating and controlling property panes.
9642
+ */
9643
+ export interface IPaneManager {
9644
+ /**
9645
+ * @remarks
9646
+ * Create a pane to be shown on the introduction window
9647
+ *
9648
+ */
9649
+ createIntroductionPane(options: IIntroductionPaneOptions): IIntroductionPane;
9650
+ /**
9651
+ * @remarks
9652
+ * Create a root pane
9653
+ *
9654
+ */
9655
+ createRootPane(options: IRootPropertyPaneOptions): IRootPropertyPane;
9656
+ }
9657
+
9536
9658
  /**
9537
9659
  * Log helper interface for Player.
9538
9660
  */
@@ -10142,6 +10264,13 @@ export interface IRootPropertyPaneHeaderAction {
10142
10264
  */
10143
10265
  // @ts-ignore Class inheritance allowed for native defined classes
10144
10266
  export interface IRootPropertyPaneOptions extends IPropertyPaneOptions {
10267
+ /**
10268
+ * @remarks
10269
+ * Optional content badge identifier associated with the root
10270
+ * pane.
10271
+ *
10272
+ */
10273
+ contentBadgeId?: string;
10145
10274
  /**
10146
10275
  * @remarks
10147
10276
  * Optional action button to be displayed on the header.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-editor",
3
- "version": "0.1.0-beta.1.26.30-preview.25",
3
+ "version": "0.1.0-beta.1.26.30-preview.27",
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.9.0-beta.1.26.30-preview.25",
18
- "@minecraft/vanilla-data": ">=1.20.70 || 1.26.30-preview.25"
17
+ "@minecraft/server": "^2.9.0-beta.1.26.30-preview.27",
18
+ "@minecraft/vanilla-data": ">=1.20.70 || 1.26.30-preview.27"
19
19
  },
20
20
  "license": "MIT"
21
21
  }