@minecraft/server-ui 2.2.0-beta.1.26.40-preview.24 → 2.2.0-beta.1.26.40-preview.29

package/index.d.ts

@@ -34,7 +34,6 @@
 import * as minecraftcommon from '@minecraft/common';
 import * as minecraftserver from '@minecraft/server';
 /**
- * @rc
  * The reason why a data driven UI screen (MessageBox or
  * CustomForm) was closed.
  */
@@ -110,7 +109,6 @@ export enum FormRejectReason {
 }
 
 /**
- * @rc
  * The reason why a form visibility operation failed.
  */
 export enum FormVisibilityErrorReason {
@@ -131,7 +129,6 @@ export enum FormVisibilityErrorReason {
 }
 
 /**
- * @rc
  * An enum representing the errors that can occur during text
  * filtering. This is used to provide more context about the
  * filtering process.
@@ -358,7 +355,6 @@ export class ActionFormResponse extends FormResponse {
 }
 
 /**
- * @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
@@ -502,6 +498,31 @@ export class CustomForm {
      * {@link InvalidFormModificationError}
      */
     header(text: ObservableString | ObservableUIRawMessage | string | UIRawMessage, options?: TextOptions): CustomForm;
+    /**
+     * @beta
+     * @remarks
+     * Adds an image component to the form layout.
+     *
+     * This function can't be called in restricted-execution mode.
+     *
+     * @param src
+     * The image source path to display. Must be a relative path to
+     * an image file within the provided pack.
+     * @param pack
+     * The resource pack identifier that contains the provided
+     * image source.
+     * @param options
+     * Optional configuration for the image, such as visibility or
+     * width.
+     * @returns
+     * The form instance to allow method chaining.
+     * @throws This function can throw errors.
+     *
+     * {@link InvalidFormModificationError}
+     *
+     * {@link InvalidObservableError}
+     */
+    image(src: ObservableString | string, pack: ObservableString | string, options?: ImageOptions): CustomForm;
     /**
      * @remarks
      * Returns true if the form is currently being shown to the
@@ -672,7 +693,6 @@ export class FormResponse {
 }
 
 /**
- * @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.
@@ -1179,7 +1199,6 @@ export class ModalFormResponse extends FormResponse {
 }
 
 /**
- * @rc
  * An observable that holds a boolean value. Listeners are
  * notified whenever the value changes.
  */
@@ -1256,7 +1275,6 @@ export class ObservableBoolean {
 }
 
 /**
- * @rc
  * An observable that holds a numeric value. Listeners are
  * notified whenever the value changes.
  */
@@ -1333,7 +1351,6 @@ export class ObservableNumber {
 }
 
 /**
- * @rc
  * An observable that holds a string value. Listeners are
  * notified whenever the value changes.
  */
@@ -1429,7 +1446,6 @@ export class ObservableString {
 }
 
 /**
- * @rc
  * An observable that holds a UIRawMessage value. Listeners are
  * notified whenever the value changes.
  */
@@ -1518,7 +1534,6 @@ export class UIManager {
 }
 
 /**
- * @rc
  * Options for configuring a button component.
  */
 export interface ButtonOptions {
@@ -1546,7 +1561,6 @@ export interface ButtonOptions {
 }
 
 /**
- * @rc
  * Options for configuring a divider component in a CustomForm.
  */
 export interface DividerOptions {
@@ -1560,7 +1574,6 @@ export interface DividerOptions {
 }
 
 /**
- * @rc
  * Represents a single item in a dropdown component.
  */
 export interface DropdownItemData {
@@ -1588,7 +1601,6 @@ export interface DropdownItemData {
 }
 
 /**
- * @rc
  * Options for configuring a dropdown component.
  */
 export interface DropdownOptions {
@@ -1616,7 +1628,29 @@ export interface DropdownOptions {
 }
 
 /**
- * @rc
+ * @beta
+ * Options for configuring an image component.
+ */
+export interface ImageOptions {
+    /**
+     * @remarks
+     * When false or bound to a false ObservableBoolean, the image
+     * is hidden.
+     *
+     */
+    visible?: boolean | ObservableBoolean;
+    /**
+     * @remarks
+     * Sets the width of the image as a percentage of the width of
+     * the form. 1 is the entire form width, 0.5 is half of the
+     * form width. Greater than 1 or less than/equal to 0 will
+     * become 1.
+     *
+     */
+    width?: number | ObservableNumber;
+}
+
+/**
  * The result returned when an MessageBox is closed. Contains
  * the reason the message box was closed and the player's
  * button selection, if applicable.
@@ -1731,7 +1765,6 @@ export interface ModalFormDataToggleOptions {
 }
 
 /**
- * @rc
  * Configuration options for creating an Observable. Controls
  * how the observable value can be accessed and modified.
  */
@@ -1747,7 +1780,6 @@ export interface ObservableOptions {
 }
 
 /**
- * @rc
  * Options for configuring a slider component.
  */
 export interface SliderOptions {
@@ -1782,7 +1814,6 @@ export interface SliderOptions {
 }
 
 /**
- * @rc
  * Options for configuring a spacer component.
  */
 export interface SpacingOptions {
@@ -1796,7 +1827,6 @@ export interface SpacingOptions {
 }
 
 /**
- * @rc
  * Options for configuring a text field component.
  */
 export interface TextFieldOptions {
@@ -1824,7 +1854,6 @@ export interface TextFieldOptions {
 }
 
 /**
- * @rc
  * Options for configuring a text component (label or header).
  */
 export interface TextOptions {
@@ -1838,7 +1867,6 @@ export interface TextOptions {
 }
 
 /**
- * @rc
  * Options for configuring a toggle component.
  */
 export interface ToggleOptions {
@@ -1866,7 +1894,6 @@ export interface ToggleOptions {
 }
 
 /**
- * @rc
  * A message that can be sent to the client. This is a subset
  * of the RawMessage type, and is used for UI messages.
  */
@@ -1919,7 +1946,6 @@ export class FormRejectError extends Error {
 }
 
 /**
- * @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.
@@ -1946,7 +1972,6 @@ export class FormVisibilityError extends Error {
 }
 
 /**
- * @rc
  * Thrown when attempting to interact with a form using an
  * invalid or unknown form identifier.
  */
@@ -1964,7 +1989,6 @@ export class InvalidFormError extends Error {
 }
 
 /**
- * @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.
@@ -1984,7 +2008,6 @@ export class InvalidFormModificationError extends Error {
 }
 
 /**
- * @rc
  * Thrown when an observable value is expected to be writable,
  * but it is not.
  */
@@ -1994,7 +2017,6 @@ export class InvalidObservableError extends Error {
 }
 
 /**
- * @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.2.0-beta.1.26.40-preview.24",
+  "version": "2.2.0-beta.1.26.40-preview.29",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^2.0.0 || ^2.10.0-beta.1.26.40-preview.24"
+    "@minecraft/server": "^2.0.0 || ^2.10.0-beta.1.26.40-preview.29"
   },
   "license": "MIT"
 }