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

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,6 +1263,14 @@ 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
  */
@@ -1343,6 +1365,7 @@ export enum ThemeSettingsColorKey {
     PrefillVolumeBorder = 'PrefillVolumeBorder',
     PrefillVolumeFill = 'PrefillVolumeFill',
     PrimaryActive = 'PrimaryActive',
+    PrimaryAttention = 'PrimaryAttention',
     PrimaryBackground1 = 'PrimaryBackground1',
     PrimaryBackground2 = 'PrimaryBackground2',
     PrimaryBackground3 = 'PrimaryBackground3',
@@ -1352,6 +1375,7 @@ export enum ThemeSettingsColorKey {
     PrimaryMute = 'PrimaryMute',
     ScrollBar = 'ScrollBar',
     SecondaryActive = 'SecondaryActive',
+    SecondaryAttention = 'SecondaryAttention',
     SecondaryBackground1 = 'SecondaryBackground1',
     SecondaryBackground2 = 'SecondaryBackground2',
     SecondaryBackground3 = 'SecondaryBackground3',
@@ -1380,6 +1404,7 @@ export enum WidgetComponentType {
     Gizmo = 'Gizmo',
     Grid = 'Grid',
     Guide = 'Guide',
+    RenderPlane = 'RenderPlane',
     RenderPrim = 'RenderPrim',
     Spline = 'Spline',
     Text = 'Text',
@@ -3426,6 +3451,7 @@ export class ExtensionContext {
      *
      */
     readonly extensionInfo: Extension;
+    readonly guidePlaneManager: GuidePlaneManager;
     /**
      * @remarks
      * Manager for minimap functionality, providing interface for
@@ -3574,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;
@@ -4896,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.
@@ -5239,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();
@@ -6007,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;
 }
 
 /**
@@ -6339,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.
  */
@@ -7691,6 +7843,19 @@ export interface IDisposable {
     teardown(): void;
 }
 
+/**
+ * Optional properties for Divider property item
+ */
+export interface IDividerPropertyItemOptions {
+    /**
+     * @remarks
+     * If true, renders the divider as a vertical line rather than
+     * horizontal.
+     *
+     */
+    vertical?: boolean;
+}
+
 /**
  * A property item which supports Dropdown properties
  */
@@ -7857,6 +8022,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;
 }
 
 /**
@@ -8484,6 +8662,32 @@ export interface IListPaneViewControlPaneOptions extends IListViewControlPaneOpt
      *
      */
     onFilterChanged?: (visibleSlotIds: string[]) => void;
+    /**
+     * @remarks
+     * Called when the user selects an entry in the "Show"
+     * dropdown. Receives the zero-based option index from the
+     * provided showOptions.
+     *
+     */
+    onShowOptionChanged?: (optionIndex: number) => void;
+    /**
+     * @remarks
+     * When true, the view control renders inline at the bottom of
+     * the list element instead of in a footer.
+     *
+     */
+    renderInline?: boolean;
+    /**
+     * @remarks
+     * Labels for the "Show" dropdown. When provided, a dropdown is
+     * shown and onShowOptionChanged is called with the selected
+     * index whenever the user changes the selection.
+     *
+     */
+    showOptions?: {
+        label: LocalizedString;
+        value: number;
+    }[];
     /**
      * @remarks
      * Custom sort options. If undefined, list pane sort options
@@ -8974,7 +9178,7 @@ export interface IModalControlPane extends IPane {
      * Adds an divider item to the pane.
      *
      */
-    addDivider(): IPropertyItemBase;
+    addDivider(options?: IDividerPropertyItemOptions): IPropertyItemBase;
 }
 
 export interface IModalDialog {
@@ -9191,6 +9395,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.
@@ -9943,7 +10157,7 @@ export interface IPropertyPane extends IPane {
      * Adds an divider item to the pane.
      *
      */
-    addDivider(): IPropertyItemBase;
+    addDivider(options?: IDividerPropertyItemOptions): IPropertyItemBase;
     /**
      * @remarks
      * Adds an Dropdown item to the pane.
@@ -10528,6 +10742,13 @@ export interface ISubPanePropertyItemOptions extends IPropertyPaneOptions {
      *
      */
     hasMargins?: boolean;
+    /**
+     * @remarks
+     * Custom height of the property item. Use LayoutFlex.Grow to
+     * fill available vertical space.
+     *
+     */
+    height?: number | LayoutSize | LayoutFlex;
     /**
      * @remarks
      * Pane icon shown in front of the pane header
@@ -11357,6 +11578,12 @@ export interface ModalToolCreationParameters {
      *
      */
     action?: RegisteredAction<NoArgsAction>;
+    /**
+     * @remarks
+     * Content badge id associated with the modal tool
+     *
+     */
+    contentBadgeId?: string;
     /**
      * @remarks
      * Icon resource
@@ -11498,6 +11725,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.27",
+  "version": "0.1.0-beta.1.26.30-preview.30",
   "description": "",
   "contributors": [
     {
@@ -14,8 +14,8 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.9.0-beta.1.26.30-preview.27",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.30-preview.27"
+    "@minecraft/server": "^2.9.0-beta.1.26.30-preview.30",
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.30-preview.30"
   },
   "license": "MIT"
 }