@minecraft/server-ui 2.1.0-rc.1.26.40-preview.24 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -2
- package/index.d.ts +0 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,8 +10,6 @@ The `@minecraft/server-ui` module contains types for expressing simple dialog-ba
|
|
|
10
10
|
|
|
11
11
|
* [*@minecraft/server-ui.ModalFormData*](../../../scriptapi/minecraft/server-ui/ModalFormData.md) allow for a more flexible "questionnaire-style" list of controls that can be used to take input.
|
|
12
12
|
|
|
13
|
-
## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
|
|
14
|
-
|
|
15
13
|
See full documentation for this module here:
|
|
16
14
|
|
|
17
15
|
https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-ui/minecraft-server-ui
|
package/index.d.ts
CHANGED
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
Copyright (c) Microsoft Corporation.
|
|
8
8
|
***************************************************************************** */
|
|
9
9
|
/**
|
|
10
|
-
* @preview
|
|
11
10
|
* @packageDocumentation
|
|
12
11
|
* The `@minecraft/server-ui` module contains types for
|
|
13
12
|
* expressing simple dialog-based user experiences.
|
|
@@ -34,7 +33,6 @@
|
|
|
34
33
|
import * as minecraftcommon from '@minecraft/common';
|
|
35
34
|
import * as minecraftserver from '@minecraft/server';
|
|
36
35
|
/**
|
|
37
|
-
* @rc
|
|
38
36
|
* The reason why a data driven UI screen (MessageBox or
|
|
39
37
|
* CustomForm) was closed.
|
|
40
38
|
*/
|
|
@@ -110,7 +108,6 @@ export enum FormRejectReason {
|
|
|
110
108
|
}
|
|
111
109
|
|
|
112
110
|
/**
|
|
113
|
-
* @rc
|
|
114
111
|
* The reason why a form visibility operation failed.
|
|
115
112
|
*/
|
|
116
113
|
export enum FormVisibilityErrorReason {
|
|
@@ -131,7 +128,6 @@ export enum FormVisibilityErrorReason {
|
|
|
131
128
|
}
|
|
132
129
|
|
|
133
130
|
/**
|
|
134
|
-
* @rc
|
|
135
131
|
* An enum representing the errors that can occur during text
|
|
136
132
|
* filtering. This is used to provide more context about the
|
|
137
133
|
* filtering process.
|
|
@@ -358,7 +354,6 @@ export class ActionFormResponse extends FormResponse {
|
|
|
358
354
|
}
|
|
359
355
|
|
|
360
356
|
/**
|
|
361
|
-
* @rc
|
|
362
357
|
* A customizable data driven (DDUI) form that lets you add
|
|
363
358
|
* buttons, labels, toggles, dropdowns, sliders, text fields,
|
|
364
359
|
* and more. The form layout is built by calling methods to add
|
|
@@ -672,7 +667,6 @@ export class FormResponse {
|
|
|
672
667
|
}
|
|
673
668
|
|
|
674
669
|
/**
|
|
675
|
-
* @rc
|
|
676
670
|
* A simple message form with two buttons and a text body. Use
|
|
677
671
|
* this class to show a basic dialog to a player and handle the
|
|
678
672
|
* player's button selection.
|
|
@@ -1179,7 +1173,6 @@ export class ModalFormResponse extends FormResponse {
|
|
|
1179
1173
|
}
|
|
1180
1174
|
|
|
1181
1175
|
/**
|
|
1182
|
-
* @rc
|
|
1183
1176
|
* An observable that holds a boolean value. Listeners are
|
|
1184
1177
|
* notified whenever the value changes.
|
|
1185
1178
|
*/
|
|
@@ -1256,7 +1249,6 @@ export class ObservableBoolean {
|
|
|
1256
1249
|
}
|
|
1257
1250
|
|
|
1258
1251
|
/**
|
|
1259
|
-
* @rc
|
|
1260
1252
|
* An observable that holds a numeric value. Listeners are
|
|
1261
1253
|
* notified whenever the value changes.
|
|
1262
1254
|
*/
|
|
@@ -1333,7 +1325,6 @@ export class ObservableNumber {
|
|
|
1333
1325
|
}
|
|
1334
1326
|
|
|
1335
1327
|
/**
|
|
1336
|
-
* @rc
|
|
1337
1328
|
* An observable that holds a string value. Listeners are
|
|
1338
1329
|
* notified whenever the value changes.
|
|
1339
1330
|
*/
|
|
@@ -1429,7 +1420,6 @@ export class ObservableString {
|
|
|
1429
1420
|
}
|
|
1430
1421
|
|
|
1431
1422
|
/**
|
|
1432
|
-
* @rc
|
|
1433
1423
|
* An observable that holds a UIRawMessage value. Listeners are
|
|
1434
1424
|
* notified whenever the value changes.
|
|
1435
1425
|
*/
|
|
@@ -1518,7 +1508,6 @@ export class UIManager {
|
|
|
1518
1508
|
}
|
|
1519
1509
|
|
|
1520
1510
|
/**
|
|
1521
|
-
* @rc
|
|
1522
1511
|
* Options for configuring a button component.
|
|
1523
1512
|
*/
|
|
1524
1513
|
export interface ButtonOptions {
|
|
@@ -1546,7 +1535,6 @@ export interface ButtonOptions {
|
|
|
1546
1535
|
}
|
|
1547
1536
|
|
|
1548
1537
|
/**
|
|
1549
|
-
* @rc
|
|
1550
1538
|
* Options for configuring a divider component in a CustomForm.
|
|
1551
1539
|
*/
|
|
1552
1540
|
export interface DividerOptions {
|
|
@@ -1560,7 +1548,6 @@ export interface DividerOptions {
|
|
|
1560
1548
|
}
|
|
1561
1549
|
|
|
1562
1550
|
/**
|
|
1563
|
-
* @rc
|
|
1564
1551
|
* Represents a single item in a dropdown component.
|
|
1565
1552
|
*/
|
|
1566
1553
|
export interface DropdownItemData {
|
|
@@ -1588,7 +1575,6 @@ export interface DropdownItemData {
|
|
|
1588
1575
|
}
|
|
1589
1576
|
|
|
1590
1577
|
/**
|
|
1591
|
-
* @rc
|
|
1592
1578
|
* Options for configuring a dropdown component.
|
|
1593
1579
|
*/
|
|
1594
1580
|
export interface DropdownOptions {
|
|
@@ -1616,7 +1602,6 @@ export interface DropdownOptions {
|
|
|
1616
1602
|
}
|
|
1617
1603
|
|
|
1618
1604
|
/**
|
|
1619
|
-
* @rc
|
|
1620
1605
|
* The result returned when an MessageBox is closed. Contains
|
|
1621
1606
|
* the reason the message box was closed and the player's
|
|
1622
1607
|
* button selection, if applicable.
|
|
@@ -1731,7 +1716,6 @@ export interface ModalFormDataToggleOptions {
|
|
|
1731
1716
|
}
|
|
1732
1717
|
|
|
1733
1718
|
/**
|
|
1734
|
-
* @rc
|
|
1735
1719
|
* Configuration options for creating an Observable. Controls
|
|
1736
1720
|
* how the observable value can be accessed and modified.
|
|
1737
1721
|
*/
|
|
@@ -1747,7 +1731,6 @@ export interface ObservableOptions {
|
|
|
1747
1731
|
}
|
|
1748
1732
|
|
|
1749
1733
|
/**
|
|
1750
|
-
* @rc
|
|
1751
1734
|
* Options for configuring a slider component.
|
|
1752
1735
|
*/
|
|
1753
1736
|
export interface SliderOptions {
|
|
@@ -1782,7 +1765,6 @@ export interface SliderOptions {
|
|
|
1782
1765
|
}
|
|
1783
1766
|
|
|
1784
1767
|
/**
|
|
1785
|
-
* @rc
|
|
1786
1768
|
* Options for configuring a spacer component.
|
|
1787
1769
|
*/
|
|
1788
1770
|
export interface SpacingOptions {
|
|
@@ -1796,7 +1778,6 @@ export interface SpacingOptions {
|
|
|
1796
1778
|
}
|
|
1797
1779
|
|
|
1798
1780
|
/**
|
|
1799
|
-
* @rc
|
|
1800
1781
|
* Options for configuring a text field component.
|
|
1801
1782
|
*/
|
|
1802
1783
|
export interface TextFieldOptions {
|
|
@@ -1824,7 +1805,6 @@ export interface TextFieldOptions {
|
|
|
1824
1805
|
}
|
|
1825
1806
|
|
|
1826
1807
|
/**
|
|
1827
|
-
* @rc
|
|
1828
1808
|
* Options for configuring a text component (label or header).
|
|
1829
1809
|
*/
|
|
1830
1810
|
export interface TextOptions {
|
|
@@ -1838,7 +1818,6 @@ export interface TextOptions {
|
|
|
1838
1818
|
}
|
|
1839
1819
|
|
|
1840
1820
|
/**
|
|
1841
|
-
* @rc
|
|
1842
1821
|
* Options for configuring a toggle component.
|
|
1843
1822
|
*/
|
|
1844
1823
|
export interface ToggleOptions {
|
|
@@ -1866,7 +1845,6 @@ export interface ToggleOptions {
|
|
|
1866
1845
|
}
|
|
1867
1846
|
|
|
1868
1847
|
/**
|
|
1869
|
-
* @rc
|
|
1870
1848
|
* A message that can be sent to the client. This is a subset
|
|
1871
1849
|
* of the RawMessage type, and is used for UI messages.
|
|
1872
1850
|
*/
|
|
@@ -1919,7 +1897,6 @@ export class FormRejectError extends Error {
|
|
|
1919
1897
|
}
|
|
1920
1898
|
|
|
1921
1899
|
/**
|
|
1922
|
-
* @rc
|
|
1923
1900
|
* Thrown when a form visibility operation fails, such as
|
|
1924
1901
|
* attempting to show a form that is already showing or
|
|
1925
1902
|
* attempting to close a form that is not currently open.
|
|
@@ -1946,7 +1923,6 @@ export class FormVisibilityError extends Error {
|
|
|
1946
1923
|
}
|
|
1947
1924
|
|
|
1948
1925
|
/**
|
|
1949
|
-
* @rc
|
|
1950
1926
|
* Thrown when attempting to interact with a form using an
|
|
1951
1927
|
* invalid or unknown form identifier.
|
|
1952
1928
|
*/
|
|
@@ -1964,7 +1940,6 @@ export class InvalidFormError extends Error {
|
|
|
1964
1940
|
}
|
|
1965
1941
|
|
|
1966
1942
|
/**
|
|
1967
|
-
* @rc
|
|
1968
1943
|
* Thrown when attempting to modify a form after it has already
|
|
1969
1944
|
* been shown to a player. Form properties cannot be changed
|
|
1970
1945
|
* while the form is active.
|
|
@@ -1984,7 +1959,6 @@ export class InvalidFormModificationError extends Error {
|
|
|
1984
1959
|
}
|
|
1985
1960
|
|
|
1986
1961
|
/**
|
|
1987
|
-
* @rc
|
|
1988
1962
|
* Thrown when an observable value is expected to be writable,
|
|
1989
1963
|
* but it is not.
|
|
1990
1964
|
*/
|
|
@@ -1994,7 +1968,6 @@ export class InvalidObservableError extends Error {
|
|
|
1994
1968
|
}
|
|
1995
1969
|
|
|
1996
1970
|
/**
|
|
1997
|
-
* @rc
|
|
1998
1971
|
* Thrown when a form operation fails because the target player
|
|
1999
1972
|
* has left the game.
|
|
2000
1973
|
*/
|