@minecraft/server-ui 2.1.0-beta.1.26.10-preview.22 → 2.1.0-beta.1.26.10-preview.24

package/index.d.ts

@@ -252,16 +252,15 @@ export declare class CustomForm {
      * when the button is pressed.
      *
      */
-    button(label: Observable<string> | string | UIRawMessage, onClick: () => void, options?: ButtonOptions): CustomForm;
-    /**
-     * @remarks
-     * Can this form be shown to the player right now?
-     *
-     */
-    canShow(): boolean;
+    button(
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        onClick: () => void,
+        options?: ButtonOptions,
+    ): CustomForm;
     /**
      * @remarks
-     * Closes the form. Throws an error if the form is not open.
+     * Tell the client to close the form. Throws an error if the
+     * form is not open.
      *
      */
     close(): void;
@@ -284,26 +283,48 @@ export declare class CustomForm {
      *
      */
     dropdown(
-        label: Observable<string> | string | UIRawMessage,
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
         value: Observable<number>,
         items: DropdownItem[],
         options?: DropdownOptions,
     ): CustomForm;
+    /**
+     * @remarks
+     * Inserts a header (i.e. large sized text) into the Custom
+     * form.
+     *
+     */
+    header(
+        text: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        options?: TextOptions,
+    ): CustomForm;
+    /**
+     * @remarks
+     * Returns true if the form is currently being shown to the
+     * player.
+     *
+     */
+    isShowing(): boolean;
     /**
      * @remarks
      * Inserts a label (i.e. medium sized text) into the Custom
      * form.
      *
      */
-    label(text: Observable<string> | string | UIRawMessage, options?: LabelOptions): CustomForm;
+    label(
+        text: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        options?: TextOptions,
+    ): CustomForm;
     /**
      * @remarks
-     * Shows the form to the player. Will throw errors if the form
-     * is currently being shown or if another behavior pack is
-     * showing a form.
+     * Shows the form to the player. Will return false if the
+     * client was busy (i.e. in another menu or this one is open).
+     * Will throw if the user disconnects.
      *
+     * @throws
+     *  *
      */
-    show(): Promise<void>;
+    show(): Promise<boolean>;
     /**
      * @remarks
      * Creates a slider that lets players pick a number between
@@ -311,7 +332,7 @@ export declare class CustomForm {
      *
      */
     slider(
-        label: Observable<string> | string | UIRawMessage,
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
         value: Observable<number>,
         minValue: Observable<number> | number,
         maxValue: Observable<number> | number,
@@ -330,7 +351,7 @@ export declare class CustomForm {
      *
      */
     textField(
-        label: Observable<string> | string | UIRawMessage,
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
         text: Observable<string>,
         options?: TextFieldOptions,
     ): CustomForm;
@@ -341,7 +362,7 @@ export declare class CustomForm {
      *
      */
     toggle(
-        label: Observable<string> | string | UIRawMessage,
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
         toggled: Observable<boolean>,
         options?: ToggleOptions,
     ): CustomForm;
@@ -351,7 +372,10 @@ export declare class CustomForm {
      * instead of a constructor.
      *
      */
-    static create(player: minecraftserver.Player, title: Observable<string> | string | UIRawMessage): CustomForm;
+    static create(
+        player: minecraftserver.Player,
+        title: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+    ): CustomForm;
 }
 
 /**
@@ -381,56 +405,62 @@ export class FormResponse {
 export declare class MessageBox {
     /**
      * @remarks
-     * Sets the data for the text in the body of the form. It is
-     * contained within a scroll view to allow for lots of text.
+     * Sets the data for the text in the body of the message box.
+     * It is contained within a scroll view to allow for lots of
+     * text.
      *
      */
-    body(text: Observable<string> | string | UIRawMessage): MessageBox;
+    body(text: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage): MessageBox;
     /**
      * @remarks
-     * Sets the data for the top button in the form.
+     * Sets the data for the top button in the message box.
      *
      */
     button1(
-        label: Observable<string> | string | UIRawMessage,
-        tooltip?: Observable<string> | string | UIRawMessage,
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        tooltip?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
     ): MessageBox;
     /**
      * @remarks
-     * Sets the data for the bottom button in the form.
+     * Sets the data for the bottom button in the message box.
      *
      */
     button2(
-        label: Observable<string> | string | UIRawMessage,
-        tooltip?: Observable<string> | string | UIRawMessage,
+        label: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+        tooltip?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
     ): MessageBox;
     /**
      * @remarks
-     * Closes the form. Will throw an error if the form is not
-     * open.
+     * Tell the client to close the message box. Throws {@link
+     * FormCloseError} if the message box is not open.
      *
      */
     close(): void;
     /**
      * @remarks
-     * Show this modal to the player. Will throw an error if the
-     * modal is already showing.
+     * Returns true if the message box is currently being shown to
+     * the player.
      *
      */
-    show(): Promise<MessageBoxResult>;
+    isShowing(): boolean;
     /**
      * @remarks
-     * Sets the title of form.
+     * Show this message box to the player. Will return a result
+     * even if the client was busy (i.e. in another menu). Will
+     * throw if the user disconnects.
      *
      */
-    title(text: Observable<string> | string | UIRawMessage): MessageBox;
+    show(): Promise<MessageBoxResult>;
     /**
      * @remarks
-     * Creates a message form for a certain player. Use this
-     * instead of a constructor.
+     * Creates a message box for a certain player. Use this instead
+     * of a constructor.
      *
      */
-    static create(player: minecraftserver.Player): MessageBox;
+    static create(
+        player: minecraftserver.Player,
+        title: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage,
+    ): MessageBox;
 }
 
 /**
@@ -833,7 +863,7 @@ export class ModalFormResponse extends FormResponse {
  * A class that represents data that can be Observed.
  * Extensively used for UI.
  */
-export declare class Observable<T extends string | number | boolean> {
+export declare class Observable<T extends string | number | boolean | UIRawMessage> {
     /**
      * @remarks
      * Gets the data from the Observable.
@@ -868,7 +898,10 @@ export declare class Observable<T extends string | number | boolean> {
      * Creates an Observable, use this instead of a constructor.
      *
      */
-    static create<T extends string | number | boolean>(data: T, options?: ObservableOptions): Observable<T>;
+    static create<T extends string | number | boolean | UIRawMessage>(
+        data: T,
+        options?: ObservableOptions,
+    ): Observable<T>;
 }
 
 export class UIManager {
@@ -898,7 +931,7 @@ export interface ButtonOptions {
      * The tooltip for this button, shown when hovering the button.
      *
      */
-    tooltip?: Observable<string> | string | UIRawMessage;
+    tooltip?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
     /**
      * @remarks
      * Whether or not this button is visible.
@@ -972,19 +1005,6 @@ export interface DropdownOptions {
     visible?: Observable<boolean> | boolean;
 }
 
-/**
- * @beta
- * The options for including a label in {@link CustomForm}.
- */
-export interface LabelOptions {
-    /**
-     * @remarks
-     * Whether or not this label is visible
-     *
-     */
-    visible?: Observable<boolean> | boolean;
-}
-
 /**
  * @beta
  * The result when a {@link MessageBox} is closed.
@@ -997,6 +1017,12 @@ export interface MessageBoxResult {
      *
      */
     selection?: number;
+    /**
+     * @remarks
+     * Whether the message box was shown
+     *
+     */
+    wasShown: boolean;
 }
 
 /**
@@ -1117,7 +1143,7 @@ export interface SliderOptions {
      * The description of the slider, shown in the UI.
      *
      */
-    description?: Observable<string> | string | UIRawMessage;
+    description?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
     /**
      * @remarks
      * Whether or not this slider is disabled.
@@ -1163,7 +1189,7 @@ export interface TextFieldOptions {
      * The description for this text field, shown in the UI.
      *
      */
-    description?: Observable<string> | string | UIRawMessage;
+    description?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
     /**
      * @remarks
      * Whether or not this text field is disabled.
@@ -1178,6 +1204,20 @@ export interface TextFieldOptions {
     visible?: Observable<boolean> | boolean;
 }
 
+/**
+ * @beta
+ * The options for including a label or header in {@link
+ * CustomForm}.
+ */
+export interface TextOptions {
+    /**
+     * @remarks
+     * Whether or not this label is visible
+     *
+     */
+    visible?: Observable<boolean> | boolean;
+}
+
 /**
  * @beta
  * The options for including a toggle in {@link CustomForm}.
@@ -1188,7 +1228,7 @@ export interface ToggleOptions {
      * The description for this toggle, shown in the UI.
      *
      */
-    description?: Observable<string> | string | UIRawMessage;
+    description?: Observable<string> | Observable<UIRawMessage> | string | UIRawMessage;
     /**
      * @remarks
      * Whether or not this toggle is disabled.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-ui",
-  "version": "2.1.0-beta.1.26.10-preview.22",
+  "version": "2.1.0-beta.1.26.10-preview.24",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0 || ^2.7.0-beta.1.26.10-preview.22"
+    "@minecraft/server": "^2.0.0 || ^2.7.0-beta.1.26.10-preview.24"
   },
   "license": "MIT"
 }