@minecraft/server-editor 0.1.0-beta.1.20.70-preview.25 → 0.1.0-beta.1.20.80-preview.21

package/index.d.ts

@@ -14,7 +14,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-editor",
- *   "version": "0.1.0-beta.1.20.70-preview.25"
+ *   "version": "0.1.0-beta.1.20.80-preview.21"
  * }
  * ```
  *
@@ -107,6 +107,7 @@ export declare enum EDITOR_PANE_PROPERTY_ITEM_TYPE {
     Boolean = 'editorUI:Boolean',
     Divider = 'editorUI:Divider',
     Dropdown = 'editorUI:Dropdown',
+    Image = 'editorUI:Image',
     Number = 'editorUI:Number',
     String = 'editorUI:String',
     SubPane = 'editorUI:SubPane',
@@ -289,6 +290,14 @@ export declare enum KeyInputType {
     Release = 2,
 }
 
+/**
+ * Layout directions for property panes.
+ */
+export declare enum LayoutDirection {
+    Vertical = 0,
+    Horizontal = 1,
+}
+
 /**
  * Mouse device action categories
  */
@@ -351,6 +360,12 @@ export enum PlaytestSessionResult {
     UnspecifiedError = 11,
 }
 
+export enum WidgetGroupSelectionMode {
+    Multiple = 'Multiple',
+    None = 'None',
+    Single = 'Single',
+}
+
 /**
  * Defines type information for graphics settings properties.
  */
@@ -927,6 +942,131 @@ export class CursorPropertyChangeAfterEventSignal {
     unsubscribe(callback: (arg: CursorPropertiesChangeAfterEvent) => void): void;
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export class CustomWidget extends Widget {
+    private constructor();
+    readonly location: minecraftserver.Vector3;
+    readonly rotation: minecraftserver.Vector2;
+    readonly showTextOnlyWhenSelected: boolean;
+    getText(): string;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setText(text: string): void;
+}
+
+export class CustomWidgetMoveEventData {
+    private constructor();
+    readonly group: WidgetGroup;
+    readonly location?: minecraftserver.Vector3;
+    readonly rotation?: minecraftserver.Vector2;
+    readonly widget: CustomWidget;
+}
+
+export class DataStore {
+    private constructor();
+    readonly actionContainer: DataStoreActionContainer;
+    readonly afterEvents: DataStoreAfterEvents;
+    readonly menuContainer: DataStoreMenuContainer;
+}
+
+export class DataStoreActionContainer {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    bindActionToControl(controlId: string, actionPayload: string): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    removeActionFromControl(controlId: string, actionPayload?: string): void;
+}
+
+export class DataStoreAfterEvents {
+    private constructor();
+    readonly payloadReceived: DataStorePayloadAfterEventSignal;
+}
+
+export class DataStoreMenuContainer {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    createItem(id: string, payload: string): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    destroyItem(id: string): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    getPayload(id: string): string;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    getProperty(id: string, property: string): boolean | number | string | undefined;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    hasPayload(id: string): boolean;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    hasProperty(id: string, property: string): boolean;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    updateItem(id: string, payload: string): void;
+}
+
+export class DataStorePayloadAfterEvent {
+    private constructor();
+    readonly dataTag: string;
+    readonly payload: string;
+}
+
+export class DataStorePayloadAfterEventSignal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    subscribe(callback: (arg: DataStorePayloadAfterEvent) => void): (arg: DataStorePayloadAfterEvent) => void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    unsubscribe(callback: (arg: DataStorePayloadAfterEvent) => void): void;
+}
+
 /**
  * Editor Extensions are the basis for all player specific,
  * editor specific functionality within the game.  Almost all
@@ -1050,6 +1190,7 @@ export class ExtensionContext {
      *
      */
     readonly transactionManager: TransactionManager;
+    readonly widgetManager: WidgetManager;
 }
 
 /**
@@ -1117,6 +1258,11 @@ export class GraphicsSettings {
     setAll(properties: GraphicsSettingsPropertyTypeMap): void;
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export class LineWidget extends Widget {
+    private constructor();
+}
+
 /**
  * The logger class is a utility class which allows editor
  * extensions to communicate with the player from the server to
@@ -1247,6 +1393,17 @@ export class MinecraftEditor {
     ): Extension;
 }
 
+export class MinecraftEditorInternal {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    getDataStore(player: minecraftserver.Player): DataStore;
+}
+
 /**
  * Contains information related to changes in player editor
  * mode.
@@ -1889,6 +2046,81 @@ export class UserDefinedTransactionHandlerId {
     private constructor();
 }
 
+export class Widget {
+    private constructor();
+    readonly valid: boolean;
+    getIsSelected(): boolean;
+    getIsVisible(): boolean;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setIsVisible(isVisible: boolean): void;
+}
+
+export class WidgetGroup {
+    private constructor();
+    readonly valid: boolean;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    createCustomWidget(
+        customEntityName: string,
+        location: minecraftserver.Vector3,
+        rotation?: minecraftserver.Vector2,
+        options?: CustomWidgetCreateOptions,
+    ): CustomWidget;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    deleteWidget(widgetToDelete: Widget): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    getIsVisible(): boolean;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     */
+    setIsVisible(isVisible: boolean): void;
+}
+
+export class WidgetManager {
+    private constructor();
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    createGroup(options?: WidgetGroupCreateOptions): WidgetGroup;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
+    deleteGroup(groupToDelete: WidgetGroup): void;
+}
+
+export class WidgetStateChangeEventData {
+    private constructor();
+    readonly group: WidgetGroup;
+    readonly isSelected?: boolean;
+    readonly isVisible?: boolean;
+    readonly widget: Widget;
+}
+
 /**
  * Interface used to specify the options when a clipboard item
  * is being written to the world
@@ -2004,6 +2236,14 @@ export interface CursorProperties {
     visible?: boolean;
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface CustomWidgetCreateOptions extends WidgetCreateOptions {
+    moveEvent?: (arg: CustomWidgetMoveEventData) => void;
+    showTextOnlyWhenSelected?: boolean;
+    text?: string;
+    visualOffset?: minecraftserver.Vector3;
+}
+
 /**
  * An interface which defines the set of optional parameters
  * which can be used when calling the `registerEditorExtension`
@@ -2082,6 +2322,16 @@ export interface PlaytestGameOptions {
     weather?: number;
 }
 
+export interface WidgetCreateOptions {
+    initialVisibility?: boolean;
+    isSelectable?: boolean;
+    stateChangeEvent?: (arg: WidgetStateChangeEventData) => void;
+}
+
+export interface WidgetGroupCreateOptions {
+    groupSelectionMode?: WidgetGroupSelectionMode;
+}
+
 /**
  * Binds actions to the client and manages their lifetime.
  * Action managers are managed on a per player basis since
@@ -2465,6 +2715,7 @@ export interface IPropertyItemOptionsBool extends IPropertyItemOptions {
 
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IPropertyItemOptionsButton extends IPropertyItemOptions {
+    icon?: string;
     /**
      * @remarks
      * The variant for the button. By default it is "primary"
@@ -2493,6 +2744,12 @@ export interface IPropertyItemOptionsDropdown extends IPropertyItemOptions {
     dropdownItems: IDropdownItem[];
 }
 
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IPropertyItemOptionsImage extends IPropertyItemOptions {
+    imageHeight: number;
+    imageWidth: number;
+}
+
 // @ts-ignore Class inheritance allowed for native defined classes
 export interface IPropertyItemOptionsNumber extends IPropertyItemOptions {
     /**
@@ -2695,6 +2952,14 @@ export interface IPropertyPane {
         property: Prop,
         options?: IPropertyItemOptionsDataPicker,
     ): IPropertyItem<T, Prop>;
+    /**
+     * @remarks
+     */
+    addImage<T extends PropertyBag, Prop extends keyof T & string>(
+        obj: T,
+        property: Prop,
+        options?: IPropertyItemOptionsImage,
+    ): IPropertyItem<T, Prop>;
     /**
      * @remarks
      * Adds a number item to the pane.
@@ -2778,6 +3043,12 @@ export interface IPropertyPane {
  * The options to create a pane.
  */
 export interface IPropertyPaneOptions {
+    /**
+     * @remarks
+     * Layout direction for sub panes
+     *
+     */
+    direction?: LayoutDirection;
     /**
      * @remarks
      * Fallback display text if no loc ID
@@ -2998,3 +3269,4 @@ export declare function registerUserDefinedTransactionHandler<T>(
  */
 export declare function stringFromException(e: unknown): string;
 export const editor: MinecraftEditor;
+export const editorInternal: MinecraftEditorInternal;

package/package.json

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