@minecraft/server-ui 1.0.0-beta.1.19.80-preview.24 → 1.0.0-beta.1.19.80-stable

package/index.d.ts

@@ -44,7 +44,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-ui",
- *   "version": "1.0.0-internal.1.19.80-preview.24"
+ *   "version": "0.1.0"
  * }
  * ```
  *
@@ -54,11 +54,13 @@ export enum FormCancelationReason {
     userBusy = 'userBusy',
     userClosed = 'userClosed',
 }
+
 export enum FormRejectReason {
     MalformedResponse = 'MalformedResponse',
     PlayerQuit = 'PlayerQuit',
     ServerShutdown = 'ServerShutdown',
 }
+
 /**
  * Builds a simple player form with buttons that let the player
  * take action.
@@ -67,12 +69,18 @@ export class ActionFormData {
     /**
      * @remarks
      * Method that sets the body text for the modal form.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     body(bodyText: minecraftserver.RawMessage | string): ActionFormData;
     /**
      * @remarks
      * Adds a button to this form with an icon from a resource
      * pack.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     button(text: minecraftserver.RawMessage | string, iconPath?: string): ActionFormData;
     /**
@@ -80,6 +88,9 @@ export class ActionFormData {
      * Creates and shows this modal popup form. Returns
      * asynchronously when the player confirms or cancels the
      * dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param player
      * Player to show this dialog to.
      * @throws This function can throw errors.
@@ -88,9 +99,13 @@ export class ActionFormData {
     /**
      * @remarks
      * This builder method sets the title for the modal dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     title(titleText: minecraftserver.RawMessage | string): ActionFormData;
 }
+
 /**
  * Returns data about the player results from a modal action
  * form.
@@ -98,25 +113,33 @@ export class ActionFormData {
 export class ActionFormResponse extends FormResponse {
     protected constructor();
     /**
+     * @remarks
      * Returns the index of the button that was pushed.
+     *
      */
     readonly selection?: number;
 }
+
 /**
  * Base type for a form response.
  */
 export class FormResponse {
     protected constructor();
     /**
+     * @remarks
      * Contains additional details as to why a form was canceled.
+     *
      */
     readonly cancelationReason?: FormCancelationReason;
     /**
+     * @remarks
      * If true, the form was canceled by the player (e.g., they
      * selected the pop-up X close button).
+     *
      */
     readonly canceled: boolean;
 }
+
 /**
  * Builds a simple two-button modal dialog.
  */
@@ -124,18 +147,27 @@ export class MessageFormData {
     /**
      * @remarks
      * Method that sets the body text for the modal form.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     body(bodyText: minecraftserver.RawMessage | string): MessageFormData;
     /**
      * @remarks
      * Method that sets the text for the first button of the
      * dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     button1(text: minecraftserver.RawMessage | string): MessageFormData;
     /**
      * @remarks
      * This method sets the text for the second button on the
      * dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     button2(text: minecraftserver.RawMessage | string): MessageFormData;
     /**
@@ -143,6 +175,9 @@ export class MessageFormData {
      * Creates and shows this modal popup form. Returns
      * asynchronously when the player confirms or cancels the
      * dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param player
      * Player to show this dialog to.
      * @throws This function can throw errors.
@@ -151,9 +186,13 @@ export class MessageFormData {
     /**
      * @remarks
      * This builder method sets the title for the modal dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     title(titleText: minecraftserver.RawMessage | string): MessageFormData;
 }
+
 /**
  * Returns data about the player results from a modal message
  * form.
@@ -161,10 +200,13 @@ export class MessageFormData {
 export class MessageFormResponse extends FormResponse {
     protected constructor();
     /**
+     * @remarks
      * Returns the index of the button that was pushed.
+     *
      */
     readonly selection?: number;
 }
+
 /**
  * Used to create a fully customizable pop-up form for a
  * player.
@@ -173,6 +215,9 @@ export class ModalFormData {
     /**
      * @remarks
      * Adds a dropdown with choices to the form.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     dropdown(
         label: minecraftserver.RawMessage | string,
@@ -184,6 +229,9 @@ export class ModalFormData {
      * Creates and shows this modal popup form. Returns
      * asynchronously when the player confirms or cancels the
      * dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param player
      * Player to show this dialog to.
      * @throws This function can throw errors.
@@ -192,6 +240,9 @@ export class ModalFormData {
     /**
      * @remarks
      * Adds a numeric slider to the form.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     slider(
         label: minecraftserver.RawMessage | string,
@@ -203,6 +254,9 @@ export class ModalFormData {
     /**
      * @remarks
      * Adds a textbox to the form.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     textField(
         label: minecraftserver.RawMessage | string,
@@ -212,25 +266,35 @@ export class ModalFormData {
     /**
      * @remarks
      * This builder method sets the title for the modal dialog.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     title(titleText: minecraftserver.RawMessage | string): ModalFormData;
     /**
      * @remarks
      * Adds a toggle checkbox button to the form.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     toggle(label: minecraftserver.RawMessage | string, defaultValue?: boolean): ModalFormData;
 }
+
 /**
  * Returns data about player responses to a modal form.
  */
 export class ModalFormResponse extends FormResponse {
     protected constructor();
     /**
+     * @remarks
      * An ordered set of values based on the order of controls
      * specified by ModalFormData.
+     *
      */
     readonly formValues?: any[];
 }
+
 export class FormRejectError extends Error {
     protected constructor();
     reason: FormRejectReason;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-ui",
-  "version": "1.0.0-beta.1.19.80-preview.24",
+  "version": "1.0.0-beta.1.19.80-stable",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/server": "1.2.0-beta.1.19.80-preview.24"
+    "@minecraft/server": "1.2.0-beta.1.19.80-stable"
   },
   "license": "MIT"
 }