@minecraft/server-editor 0.1.0-beta.1.26.30-preview.26 → 0.1.0-beta.1.26.30-preview.28

package/index.d.ts

@@ -890,6 +890,12 @@ export declare enum KeyboardKey {
      *
      */
     F12 = 123,
+    /**
+     * @remarks
+     * KeyboardEvent.DOM_VK_SEMICOLON, ie. ';'
+     *
+     */
+    SEMICOLON = 186,
     /**
      * @remarks
      * KeyboardEvent.DOM_VK_COMMA, ie. ','
@@ -1118,6 +1124,14 @@ export declare enum MouseActionType {
     Wheel = 4,
 }
 
+export enum MouseCursorIconType {
+    Crosshair = 'Crosshair',
+    Default = 'Default',
+    Move = 'Move',
+    NotAllowed = 'NotAllowed',
+    Wait = 'Wait',
+}
+
 /**
  * Input event information about mouse actions
  */
@@ -1249,12 +1263,21 @@ export declare enum PropertyItemType {
     Vector3Timeline = 'editorUI:Vector3Timeline',
 }
 
+export enum RenderPlaneGridResolution {
+    EightBlocks = 'EightBlocks',
+    FourBlocks = 'FourBlocks',
+    None = 'None',
+    OneBlock = 'OneBlock',
+    SixteenBlocks = 'SixteenBlocks',
+}
+
 /**
  * Determines the location root pane will be displayed in
  */
 export declare enum RootPaneLocation {
     Drawer = 0,
     Viewport = 1,
+    Bottom = 2,
 }
 
 export enum SelectionVolumeEventType {
@@ -1342,6 +1365,7 @@ export enum ThemeSettingsColorKey {
     PrefillVolumeBorder = 'PrefillVolumeBorder',
     PrefillVolumeFill = 'PrefillVolumeFill',
     PrimaryActive = 'PrimaryActive',
+    PrimaryAttention = 'PrimaryAttention',
     PrimaryBackground1 = 'PrimaryBackground1',
     PrimaryBackground2 = 'PrimaryBackground2',
     PrimaryBackground3 = 'PrimaryBackground3',
@@ -1351,6 +1375,7 @@ export enum ThemeSettingsColorKey {
     PrimaryMute = 'PrimaryMute',
     ScrollBar = 'ScrollBar',
     SecondaryActive = 'SecondaryActive',
+    SecondaryAttention = 'SecondaryAttention',
     SecondaryBackground1 = 'SecondaryBackground1',
     SecondaryBackground2 = 'SecondaryBackground2',
     SecondaryBackground3 = 'SecondaryBackground3',
@@ -1379,6 +1404,7 @@ export enum WidgetComponentType {
     Gizmo = 'Gizmo',
     Grid = 'Grid',
     Guide = 'Guide',
+    RenderPlane = 'RenderPlane',
     RenderPrim = 'RenderPrim',
     Spline = 'Spline',
     Text = 'Text',
@@ -1628,11 +1654,13 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
     createPropertyPane(options: IRootPropertyPaneOptions): IRootPropertyPane;
     readonly actionManager: ActionManager;
     readonly inputManager: IGlobalInputManager;
+    readonly paneManager: IPaneManager;
     readonly menuBar: IMenuContainer;
     readonly actionBar: IActionBar;
     readonly statusBar: IStatusBar;
     readonly dialogManager: IModalDialogManager;
     readonly toolRail: IModalToolContainer;
+    readonly badgeManager: IContentBadgeManager;
     readonly log: IPlayerLogger;
     readonly extensionContext: ExtensionContext;
     readonly builtInUIManager: BuiltInUIManager;
@@ -3423,6 +3451,7 @@ export class ExtensionContext {
      *
      */
     readonly extensionInfo: Extension;
+    readonly guidePlaneManager: GuidePlaneManager;
     /**
      * @remarks
      * Manager for minimap functionality, providing interface for
@@ -3571,6 +3600,78 @@ export class GraphicsSettings {
     setAll(properties: GraphicsSettingsPropertyTypeMap): void;
 }
 
+export class GuidePlaneManager {
+    private constructor();
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    allPlanesVisible: boolean;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    addPlane(
+        origin: minecraftserver.Vector3,
+        normal: minecraftserver.Vector3,
+        visible: boolean,
+        outlineColor: minecraftserver.RGBA,
+        fillColor: minecraftserver.RGBA,
+    ): string;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    getPlane(planeId: string): GuidePlane | undefined;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    getPlanes(): GuidePlane[];
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    removePlane(planeId: string): void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setPlaneColors(planeId: string, outlineColor: minecraftserver.RGBA, fillColor: minecraftserver.RGBA): void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setPlaneNormal(planeId: string, normal: minecraftserver.Vector3): void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setPlaneOrigin(planeId: string, origin: minecraftserver.Vector3): void;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    setPlaneVisibility(planeId: string, visible: boolean): void;
+}
+
 export class IBlockPaletteItem {
     private constructor();
     getBlock(): minecraftserver.BlockType | undefined;
@@ -4893,6 +4994,16 @@ export class Widget {
      * @throws This function can throw errors.
      */
     addGuideComponent(componentName: string, options?: WidgetComponentGuideOptions): WidgetComponentGuide;
+    /**
+     * @remarks
+     * This function can't be called in restricted-execution mode.
+     *
+     * @throws This function can throw errors.
+     */
+    addRenderPlaneComponent(
+        componentName: string,
+        options?: WidgetComponentRenderPlaneOptions,
+    ): WidgetComponentRenderPlane;
     /**
      * @remarks
      * This function can't be called in restricted-execution mode.
@@ -5236,6 +5347,41 @@ export class WidgetComponentGuide extends WidgetComponentBase {
     private constructor();
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export class WidgetComponentRenderPlane extends WidgetComponentBase {
+    private constructor();
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    fillColor: minecraftserver.RGBA;
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    gridResolution: RenderPlaneGridResolution;
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    maxSizeChunks: number;
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    normal: minecraftserver.Vector3;
+    /**
+     * @remarks
+     * This property can't be edited in restricted-execution mode.
+     *
+     */
+    outlineColor: minecraftserver.RGBA;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export class WidgetComponentRenderPrimitive extends WidgetComponentBase {
     private constructor();
@@ -6004,22 +6150,22 @@ export interface BuiltInUIManager {
     saveAndExit(): void;
     /**
      * @remarks
-     * Updates the visibility of the log panel
+     * Shows update information for the current version
      *
      */
-    updateLogPanelVisibility(visibility: boolean): void;
+    showUpdateInformation(): void;
     /**
      * @remarks
-     * Updates the visibility of the control demo
+     * Updates the visibility of the log panel
      *
      */
-    updateUISettingsPanelVisibility(visibility: boolean): void;
+    updateLogPanelVisibility(visibility: boolean): void;
     /**
      * @remarks
-     * Updates the visibility of the welcome panel
+     * Updates the visibility of the control demo
      *
      */
-    updateWelcomePanelVisibility(visibility: boolean): void;
+    updateUISettingsPanelVisibility(visibility: boolean): void;
 }
 
 /**
@@ -6336,6 +6482,15 @@ export interface GameOptions {
     worldName?: string;
 }
 
+export interface GuidePlane {
+    fillColor: minecraftserver.RGBA;
+    normal: minecraftserver.Vector3;
+    origin: minecraftserver.Vector3;
+    outlineColor: minecraftserver.RGBA;
+    planeId: string;
+    visible: boolean;
+}
+
 /**
  * Manager for IActionBarItem objects.
  */
@@ -6400,6 +6555,12 @@ export interface IActionBarItem {
  * Properties required to create an Action Bar item.
  */
 export interface IActionBarItemCreationParams {
+    /**
+     * @remarks
+     * Optional content badge identifier associated with the item.
+     *
+     */
+    contentBadgeId?: string;
     /**
      * @remarks
      * Initial enabled state of the item. If not defined, default
@@ -7584,6 +7745,27 @@ export interface IComboBoxPropertyItemOptions extends IPropertyItemOptionsBase {
     tooltip?: BasicTooltipContent;
 }
 
+export interface IContentBadgeManager {
+    /**
+     * @remarks
+     * Register a badge to highlight a content.
+     *
+     * @param id
+     * The badge identifier
+     * @param iteration
+     * The iteration number (default: 0)
+     */
+    registerBadge(id: string, iteration?: number): void;
+    /**
+     * @remarks
+     * Unregister a badge.
+     *
+     * @param id
+     * The badge identifier to unregister
+     */
+    unregisterBadge(id: string): void;
+}
+
 /**
  * A property item which supports data entries displayed in a
  * table
@@ -7827,6 +8009,19 @@ export interface IGlobalInputManager {
         binding: KeyBinding,
         info?: KeyBindingInfo,
     ): IRegisteredKeyBinding;
+    /**
+     * @remarks
+     * Set or clear the mouse cursor icon for a given editor input
+     * context layer.
+     *
+     * @param contextId
+     * The editor input context id (maps to EditorInputContext).
+     * @param mouseIcon
+     * The MouseCursorIconType, or null to clear.
+     * @throws
+     *  *
+     */
+    setMouseIcon(contextId: EditorInputContext, mouseIcon: MouseCursorIconType | undefined): void;
 }
 
 /**
@@ -7895,6 +8090,38 @@ export interface IImagePropertyItemOptions extends IPropertyItemOptionsBase {
     onClick?: (x: number, y: number) => void;
 }
 
+/**
+ * A root pane that can store property items.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IIntroductionPane extends IPane {
+    /**
+     * @remarks
+     * Adds a new tab to the introduction pane
+     *
+     */
+    addTab(props: IntroductionPaneTabProps): IPropertyPane;
+}
+
+/**
+ * The options to create introduction pane.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IIntroductionPaneOptions extends IPropertyPaneOptions {
+    /**
+     * @remarks
+     * Localized title of the property pane
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Unique identifier for the pane
+     *
+     */
+    uniqueId?: string;
+}
+
 /**
  * A property item which supports Link properties
  */
@@ -8634,6 +8861,12 @@ export interface IMenuCreationParams {
      *
      */
     label: string;
+    /**
+     * @remarks
+     * Determines the order of the menu item among its siblings.
+     *
+     */
+    sortIndex?: number;
     /**
      * @remarks
      * Whether the menu should have a tooltip.
@@ -9123,6 +9356,16 @@ export interface IModalTool {
      * Action to register the binding for.
      */
     registerMouseWheelBinding(action: SupportedMouseActionTypes): void;
+    /**
+     * @remarks
+     * Set the mouse cursor icon for this tool when it's active.
+     * The icon will only be visible when this tool is the
+     * currently selected tool.
+     *
+     * @param mouseIcon
+     * The mouse cursor icon, or undefined to reset to default.
+     */
+    setMouseIcon(mouseIcon: MouseCursorIconType | undefined): void;
     /**
      * @remarks
      * Unregister all input binding for this tool.
@@ -9204,6 +9447,42 @@ export interface IModalToolContainer {
     setSortOrder(ids: string[] | undefined): void;
 }
 
+/**
+ * Properties for introduction pane tab.
+ */
+export interface IntroductionPaneTabProps {
+    /**
+     * @remarks
+     * Optional header for the tab content
+     *
+     */
+    contentHeader?: LocalizedString;
+    /**
+     * @remarks
+     * Optional image for the tab content
+     *
+     */
+    contentImage?: string;
+    /**
+     * @remarks
+     * Icon for the tab
+     *
+     */
+    icon?: string;
+    /**
+     * @remarks
+     * Unique identifier for the tab
+     *
+     */
+    id: string;
+    /**
+     * @remarks
+     * Localized title of the tab
+     *
+     */
+    label: LocalizedString;
+}
+
 /**
  * A property item which supports Number properties
  */
@@ -9533,6 +9812,24 @@ export interface IPane {
     show(): void;
 }
 
+/**
+ * Manager for creating and controlling property panes.
+ */
+export interface IPaneManager {
+    /**
+     * @remarks
+     * Create a pane to be shown on the introduction window
+     *
+     */
+    createIntroductionPane(options: IIntroductionPaneOptions): IIntroductionPane;
+    /**
+     * @remarks
+     * Create a root pane
+     *
+     */
+    createRootPane(options: IRootPropertyPaneOptions): IRootPropertyPane;
+}
+
 /**
  * Log helper interface for Player.
  */
@@ -10142,6 +10439,13 @@ export interface IRootPropertyPaneHeaderAction {
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IRootPropertyPaneOptions extends IPropertyPaneOptions {
+    /**
+     * @remarks
+     * Optional content badge identifier associated with the root
+     * pane.
+     *
+     */
+    contentBadgeId?: string;
     /**
      * @remarks
      * Optional action button to be displayed on the header.
@@ -11369,6 +11673,15 @@ export interface WidgetComponentGridOptions extends WidgetComponentBaseOptions {
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface WidgetComponentGuideOptions extends WidgetComponentBaseOptions {}
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface WidgetComponentRenderPlaneOptions extends WidgetComponentBaseOptions {
+    fillColor?: minecraftserver.RGBA;
+    gridResolution?: RenderPlaneGridResolution;
+    maxSizeChunks?: number;
+    normal?: minecraftserver.Vector3;
+    outlineColor?: minecraftserver.RGBA;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface WidgetComponentRenderPrimitiveOptions extends WidgetComponentBaseOptions {}
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-editor",
-  "version": "0.1.0-beta.1.26.30-preview.26",
+  "version": "0.1.0-beta.1.26.30-preview.28",
   "description": "",
   "contributors": [
     {
@@ -14,8 +14,8 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.9.0-beta.1.26.30-preview.26",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.30-preview.26"
+    "@minecraft/server": "^2.9.0-beta.1.26.30-preview.28",
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.30-preview.28"
   },
   "license": "MIT"
 }