@minecraft/server-ui 1.2.0-beta.1.20.70-preview.21 → 1.2.0-beta.1.20.70-preview.24

package/index.d.ts

@@ -63,6 +63,30 @@ export enum FormRejectReason {
 /**
  * Builds a simple player form with buttons that let the player
  * take action.
+ * @example actionFormAskFavoriteMonth.ts
+ * ```typescript
+ * import { Player } from '@minecraft/server';
+ * import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';
+ *
+ * function askFavoriteMonth(player: Player) {
+ *     const form = new ActionFormData()
+ *         .title('Months')
+ *         .body('Choose your favorite month!')
+ *         .button('January')
+ *         .button('February')
+ *         .button('March')
+ *         .button('April')
+ *         .button('May');
+ *
+ *     form.show(player).then((response: ActionFormResponse) => {
+ *         if (response.selection === 3) {
+ *             player.sendMessage('I like April too!');
+ *         } else {
+ *             player.sendMessage('Nah, April is the best.');
+ *         }
+ *     });
+ * }
+ * ```
  */
 export class ActionFormData {
     /**
@@ -102,6 +126,30 @@ export class ActionFormData {
 /**
  * Returns data about the player results from a modal action
  * form.
+ * @example actionFormAskFavoriteMonth.ts
+ * ```typescript
+ * import { Player } from '@minecraft/server';
+ * import { ActionFormData, ActionFormResponse } from '@minecraft/server-ui';
+ *
+ * function askFavoriteMonth(player: Player) {
+ *     const form = new ActionFormData()
+ *         .title('Months')
+ *         .body('Choose your favorite month!')
+ *         .button('January')
+ *         .button('February')
+ *         .button('March')
+ *         .button('April')
+ *         .button('May');
+ *
+ *     form.show(player).then((response: ActionFormResponse) => {
+ *         if (response.selection === 3) {
+ *             player.sendMessage('I like April too!');
+ *         } else {
+ *             player.sendMessage('Nah, April is the best.');
+ *         }
+ *     });
+ * }
+ * ```
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class ActionFormResponse extends FormResponse {
@@ -136,6 +184,33 @@ export class FormResponse {
 
 /**
  * Builds a simple two-button modal dialog.
+ * @example messageFormSimple.ts
+ * ```typescript
+ * import { Player } from '@minecraft/server';
+ * import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';
+ *
+ * function showMessage(player: Player) {
+ *     const messageForm = new MessageFormData()
+ *         .title({ translate: 'permissions.removeplayer' }) // "Remove player"
+ *         .body({ translate: 'accessibility.list.or.two', with: ['Player 1', 'Player 2'] }) // "Player 1 or Player 2"
+ *         .button1('Player 1')
+ *         .button2('Player 2');
+ *
+ *     messageForm
+ *         .show(player)
+ *         .then((formData: MessageFormResponse) => {
+ *             // player canceled the form, or another dialog was up and open.
+ *             if (formData.canceled || formData.selection === undefined) {
+ *                 return;
+ *             }
+ *
+ *             player.sendMessage(`You selected ${formData.selection === 0 ? 'Player 1' : 'Player 2'}`);
+ *         })
+ *         .catch((error: Error) => {
+ *             player.sendMessage('Failed to show form: ' + error);
+ *         });
+ * }
+ * ```
  */
 export class MessageFormData {
     /**
@@ -182,6 +257,33 @@ export class MessageFormData {
 /**
  * Returns data about the player results from a modal message
  * form.
+ * @example messageFormSimple.ts
+ * ```typescript
+ * import { Player } from '@minecraft/server';
+ * import { MessageFormResponse, MessageFormData } from '@minecraft/server-ui';
+ *
+ * function showMessage(player: Player) {
+ *     const messageForm = new MessageFormData()
+ *         .title({ translate: 'permissions.removeplayer' }) // "Remove player"
+ *         .body({ translate: 'accessibility.list.or.two', with: ['Player 1', 'Player 2'] }) // "Player 1 or Player 2"
+ *         .button1('Player 1')
+ *         .button2('Player 2');
+ *
+ *     messageForm
+ *         .show(player)
+ *         .then((formData: MessageFormResponse) => {
+ *             // player canceled the form, or another dialog was up and open.
+ *             if (formData.canceled || formData.selection === undefined) {
+ *                 return;
+ *             }
+ *
+ *             player.sendMessage(`You selected ${formData.selection === 0 ? 'Player 1' : 'Player 2'}`);
+ *         })
+ *         .catch((error: Error) => {
+ *             player.sendMessage('Failed to show form: ' + error);
+ *         });
+ * }
+ * ```
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class MessageFormResponse extends FormResponse {
@@ -197,6 +299,37 @@ export class MessageFormResponse extends FormResponse {
 /**
  * Used to create a fully customizable pop-up form for a
  * player.
+ * @example modalFormSimple.ts
+ * ```typescript
+ * import { Player } from '@minecraft/server';
+ * import { ModalFormData } from '@minecraft/server-ui';
+ *
+ * function showExampleModal(player: Player) {
+ *     const modalForm = new ModalFormData().title('Example Modal Controls for §o§7ModalFormData§r');
+ *
+ *     modalForm.toggle('Toggle w/o default');
+ *     modalForm.toggle('Toggle w/ default', true);
+ *
+ *     modalForm.slider('Slider w/o default', 0, 50, 5);
+ *     modalForm.slider('Slider w/ default', 0, 50, 5, 30);
+ *
+ *     modalForm.dropdown('Dropdown w/o default', ['option 1', 'option 2', 'option 3']);
+ *     modalForm.dropdown('Dropdown w/ default', ['option 1', 'option 2', 'option 3'], 2);
+ *
+ *     modalForm.textField('Input w/o default', 'type text here');
+ *     modalForm.textField('Input w/ default', 'type text here', 'this is default');
+ *
+ *     modalForm
+ *         .show(player)
+ *         .then(formData => {
+ *             player.sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
+ *         })
+ *         .catch((error: Error) => {
+ *             player.sendMessage('Failed to show form: ' + error);
+ *             return -1;
+ *         });
+ * }
+ * ```
  */
 export class ModalFormData {
     /**
@@ -260,6 +393,37 @@ export class ModalFormData {
 
 /**
  * Returns data about player responses to a modal form.
+ * @example modalFormSimple.ts
+ * ```typescript
+ * import { Player } from '@minecraft/server';
+ * import { ModalFormData } from '@minecraft/server-ui';
+ *
+ * function showExampleModal(player: Player) {
+ *     const modalForm = new ModalFormData().title('Example Modal Controls for §o§7ModalFormData§r');
+ *
+ *     modalForm.toggle('Toggle w/o default');
+ *     modalForm.toggle('Toggle w/ default', true);
+ *
+ *     modalForm.slider('Slider w/o default', 0, 50, 5);
+ *     modalForm.slider('Slider w/ default', 0, 50, 5, 30);
+ *
+ *     modalForm.dropdown('Dropdown w/o default', ['option 1', 'option 2', 'option 3']);
+ *     modalForm.dropdown('Dropdown w/ default', ['option 1', 'option 2', 'option 3'], 2);
+ *
+ *     modalForm.textField('Input w/o default', 'type text here');
+ *     modalForm.textField('Input w/ default', 'type text here', 'this is default');
+ *
+ *     modalForm
+ *         .show(player)
+ *         .then(formData => {
+ *             player.sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
+ *         })
+ *         .catch((error: Error) => {
+ *             player.sendMessage('Failed to show form: ' + error);
+ *             return -1;
+ *         });
+ * }
+ * ```
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class ModalFormResponse extends FormResponse {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-ui",
-  "version": "1.2.0-beta.1.20.70-preview.21",
+  "version": "1.2.0-beta.1.20.70-preview.24",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "dependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^1.8.0-rc.1.20.70-preview.21"
+    "@minecraft/server": "^1.8.0"
   },
   "license": "MIT"
 }