@minecraft/server-ui 2.1.0-beta.1.26.30-preview.27 → 2.1.0-rc.1.26.30-preview.30

package/index.d.ts

@@ -7,7 +7,7 @@
    Copyright (c) Microsoft Corporation.
    ***************************************************************************** */
 /**
- * @beta
+ * @preview
  * @packageDocumentation
  * The `@minecraft/server-ui` module contains types for
  * expressing simple dialog-based user experiences.
@@ -26,7 +26,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-ui",
- *   "version": "2.1.0-beta"
+ *   "version": "2.1.0"
  * }
  * ```
  *
@@ -34,7 +34,7 @@
 import * as minecraftcommon from '@minecraft/common';
 import * as minecraftserver from '@minecraft/server';
 /**
- * @beta
+ * @rc
  * The reason why a data driven UI screen (MessageBox or
  * CustomForm) was closed.
  */
@@ -63,19 +63,54 @@ export enum DataDrivenScreenClosedReason {
     UserBusy = 'UserBusy',
 }
 
+/**
+ * An enum representing the reasons why a form was canceled.
+ */
 export enum FormCancelationReason {
+    /**
+     * @remarks
+     * The form was canceled because the player was busy with
+     * another UI interaction.
+     *
+     */
     UserBusy = 'UserBusy',
+    /**
+     * @remarks
+     * The form was canceled because the player closed it.
+     *
+     */
     UserClosed = 'UserClosed',
 }
 
+/**
+ * An enum representing the reasons why a form was rejected.
+ */
 export enum FormRejectReason {
+    /**
+     * @remarks
+     * The form was rejected because the response from the client
+     * was malformed or could not be parsed.
+     *
+     */
     MalformedResponse = 'MalformedResponse',
+    /**
+     * @remarks
+     * The form was rejected because the player quit the game
+     * before responding.
+     *
+     */
     PlayerQuit = 'PlayerQuit',
+    /**
+     * @remarks
+     * The form was rejected because the server shut down before
+     * the player responded.
+     *
+     */
     ServerShutdown = 'ServerShutdown',
 }
 
 /**
- * @beta
+ * @rc
  * The reason why a form visibility operation failed.
  */
 export enum FormVisibilityErrorReason {
@@ -96,7 +131,7 @@ export enum FormVisibilityErrorReason {
 }
 
 /**
- * @beta
+ * @rc
  * An enum representing the errors that can occur during text
  * filtering. This is used to provide more context about the
  * filtering process.
@@ -323,7 +358,7 @@ export class ActionFormResponse extends FormResponse {
 }
 
 /**
- * @beta
+ * @rc
  * A customizable data driven (DDUI) form that lets you add
  * buttons, labels, toggles, dropdowns, sliders, text fields,
  * and more. The form layout is built by calling methods to add
@@ -440,6 +475,8 @@ export class CustomForm {
      * @throws This function can throw errors.
      *
      * {@link InvalidFormModificationError}
+     *
+     * {@link InvalidObservableError}
      */
     dropdown(
         label: ObservableString | ObservableUIRawMessage | string | UIRawMessage,
@@ -531,6 +568,8 @@ export class CustomForm {
      * @throws This function can throw errors.
      *
      * {@link InvalidFormModificationError}
+     *
+     * {@link InvalidObservableError}
      */
     slider(
         label: ObservableString | ObservableUIRawMessage | string | UIRawMessage,
@@ -574,6 +613,8 @@ export class CustomForm {
      * @throws This function can throw errors.
      *
      * {@link InvalidFormModificationError}
+     *
+     * {@link InvalidObservableError}
      */
     textField(
         label: ObservableString | ObservableUIRawMessage | string | UIRawMessage,
@@ -600,6 +641,8 @@ export class CustomForm {
      * @throws This function can throw errors.
      *
      * {@link InvalidFormModificationError}
+     *
+     * {@link InvalidObservableError}
      */
     toggle(
         label: ObservableString | ObservableUIRawMessage | string | UIRawMessage,
@@ -629,7 +672,7 @@ export class FormResponse {
 }
 
 /**
- * @beta
+ * @rc
  * A simple message form with two buttons and a text body. Use
  * this class to show a basic dialog to a player and handle the
  * player's button selection.
@@ -1136,7 +1179,7 @@ export class ModalFormResponse extends FormResponse {
 }
 
 /**
- * @beta
+ * @rc
  * An observable that holds a boolean value. Listeners are
  * notified whenever the value changes.
  */
@@ -1213,7 +1256,7 @@ export class ObservableBoolean {
 }
 
 /**
- * @beta
+ * @rc
  * An observable that holds a numeric value. Listeners are
  * notified whenever the value changes.
  */
@@ -1290,7 +1333,7 @@ export class ObservableNumber {
 }
 
 /**
- * @beta
+ * @rc
  * An observable that holds a string value. Listeners are
  * notified whenever the value changes.
  */
@@ -1386,19 +1429,32 @@ export class ObservableString {
 }
 
 /**
- * @beta
+ * @rc
+ * An observable that holds a UIRawMessage value. Listeners are
+ * notified whenever the value changes.
  */
 export class ObservableUIRawMessage {
     /**
      * @remarks
+     * Creates a new ObservableUIRawMessage with the provided
+     * initial UIRawMessage value.
+     *
      * This function can't be called in restricted-execution mode.
      *
      * This function can be called in early-execution mode.
      *
+     * @param data
+     * The initial UIRawMessage value for this observable.
+     * @param options
+     * Optional configuration for the observable, such as whether
+     * the value can be written by the client.
      */
     constructor(data: UIRawMessage, options?: ObservableOptions);
     /**
      * @remarks
+     * Returns the current UIRawMessage value held by this
+     * observable.
+     *
      * This function can't be called in restricted-execution mode.
      *
      * This function can be called in early-execution mode.
@@ -1407,26 +1463,45 @@ export class ObservableUIRawMessage {
     getData(): UIRawMessage;
     /**
      * @remarks
+     * Updates the UIRawMessage value held by this observable. If
+     * the new value differs from the current value, all subscribed
+     * listeners are notified with the new value.
+     *
      * This function can't be called in restricted-execution mode.
      *
      * This function can be called in early-execution mode.
      *
+     * @param data
+     * The new UIRawMessage value to set.
      */
     setData(data: UIRawMessage): void;
     /**
      * @remarks
+     * Registers a callback to be invoked whenever the observable's
+     * value changes. Returns the callback, which can be passed to
+     * unsubscribe to remove the listener.
+     *
      * This function can't be called in restricted-execution mode.
      *
      * This function can be called in early-execution mode.
      *
+     * @param callback
+     * A function that receives the new UIRawMessage value each
+     * time the observable changes.
      */
     subscribe(callback: (arg0: UIRawMessage) => void): (arg0: UIRawMessage) => void;
     /**
      * @remarks
+     * Removes a previously registered listener from this
+     * observable. Returns true if the listener was found and
+     * removed, false if it was not found.
+     *
      * This function can't be called in restricted-execution mode.
      *
      * This function can be called in early-execution mode.
      *
+     * @param callback
+     * The callback handle previously returned by subscribe.
      */
     unsubscribe(callback: (arg0: UIRawMessage) => void): boolean;
 }
@@ -1443,7 +1518,7 @@ export class UIManager {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a button component.
  */
 export interface ButtonOptions {
@@ -1471,7 +1546,7 @@ export interface ButtonOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a divider component in a CustomForm.
  */
 export interface DividerOptions {
@@ -1485,7 +1560,7 @@ export interface DividerOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Represents a single item in a dropdown component.
  */
 export interface DropdownItemData {
@@ -1513,7 +1588,7 @@ export interface DropdownItemData {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a dropdown component.
  */
 export interface DropdownOptions {
@@ -1541,7 +1616,7 @@ export interface DropdownOptions {
 }
 
 /**
- * @beta
+ * @rc
  * The result returned when an MessageBox is closed. Contains
  * the reason the message box was closed and the player's
  * button selection, if applicable.
@@ -1656,7 +1731,7 @@ export interface ModalFormDataToggleOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Configuration options for creating an Observable. Controls
  * how the observable value can be accessed and modified.
  */
@@ -1672,7 +1747,7 @@ export interface ObservableOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a slider component.
  */
 export interface SliderOptions {
@@ -1707,7 +1782,7 @@ export interface SliderOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a spacer component.
  */
 export interface SpacingOptions {
@@ -1721,7 +1796,7 @@ export interface SpacingOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a text field component.
  */
 export interface TextFieldOptions {
@@ -1749,7 +1824,7 @@ export interface TextFieldOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a text component (label or header).
  */
 export interface TextOptions {
@@ -1763,7 +1838,7 @@ export interface TextOptions {
 }
 
 /**
- * @beta
+ * @rc
  * Options for configuring a toggle component.
  */
 export interface ToggleOptions {
@@ -1791,7 +1866,7 @@ export interface ToggleOptions {
 }
 
 /**
- * @beta
+ * @rc
  * A message that can be sent to the client. This is a subset
  * of the RawMessage type, and is used for UI messages.
  */
@@ -1826,11 +1901,17 @@ export interface UIRawMessage {
     with?: string[] | UIRawMessage;
 }
 
+/**
+ * Thrown when a form is rejected. Contains the reason for the
+ * rejection.
+ */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class FormRejectError extends Error {
     private constructor();
     /**
      * @remarks
+     * The reason the form was rejected.
+     *
      * This property can be read in early-execution mode.
      *
      */
@@ -1838,7 +1919,7 @@ export class FormRejectError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Thrown when a form visibility operation fails, such as
  * attempting to show a form that is already showing or
  * attempting to close a form that is not currently open.
@@ -1865,7 +1946,7 @@ export class FormVisibilityError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Thrown when attempting to interact with a form using an
  * invalid or unknown form identifier.
  */
@@ -1883,7 +1964,7 @@ export class InvalidFormError extends Error {
 }
 
 /**
- * @beta
+ * @rc
  * Thrown when attempting to modify a form after it has already
  * been shown to a player. Form properties cannot be changed
  * while the form is active.
@@ -1903,7 +1984,17 @@ export class InvalidFormModificationError extends Error {
 }
 
 /**
- * @beta
+ * @rc
+ * Thrown when an observable value is expected to be writable,
+ * but it is not.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export class InvalidObservableError extends Error {
+    private constructor();
+}
+
+/**
+ * @rc
  * Thrown when a form operation fails because the target player
  * has left the game.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-ui",
-  "version": "2.1.0-beta.1.26.30-preview.27",
+  "version": "2.1.0-rc.1.26.30-preview.30",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0 || ^2.9.0-beta.1.26.30-preview.27"
+    "@minecraft/server": "^2.0.0"
   },
   "license": "MIT"
 }