@minecraft/server-gametest 1.0.0-beta.1.21.95-stable → 1.0.0-beta.1.26.0-preview.24

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.
Files changed (3) hide show
  1. package/README.md +8 -8
  2. package/index.d.ts +346 -0
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # `@minecraft/server-gametest`
2
-
3
- The @minecraft/server-gametest module provides scriptable APIs for scaffolding and testing content experiences in Minecraft.
4
-
5
- ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
6
-
7
- See full documentation for this module here:
8
-
1
+ # `@minecraft/server-gametest`
2
+
3
+ The @minecraft/server-gametest module provides scriptable APIs for scaffolding and testing content experiences in Minecraft.
4
+
5
+ ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
6
+
7
+ See full documentation for this module here:
8
+
9
9
  https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-gametest/minecraft-server-gametest
package/index.d.ts CHANGED
@@ -24,6 +24,11 @@
24
24
  */
25
25
  import * as minecraftcommon from '@minecraft/common';
26
26
  import * as minecraftserver from '@minecraft/server';
27
+ export enum GameTestCompletedErrorReason {
28
+ Cleanup = 'Cleanup',
29
+ Done = 'Done',
30
+ }
31
+
27
32
  export enum GameTestErrorType {
28
33
  Assert = 'Assert',
29
34
  AssertAtPosition = 'AssertAtPosition',
@@ -43,6 +48,39 @@ export enum LookDuration {
43
48
  UntilMove = 'UntilMove',
44
49
  }
45
50
 
51
+ export enum PersonaArmSize {
52
+ Slim = 'Slim',
53
+ Wide = 'Wide',
54
+ }
55
+
56
+ export enum PersonaPieceType {
57
+ Arms = 'Arms',
58
+ Back = 'Back',
59
+ Body = 'Body',
60
+ Bottom = 'Bottom',
61
+ Capes = 'Capes',
62
+ Dress = 'Dress',
63
+ Eyes = 'Eyes',
64
+ FaceAccessory = 'FaceAccessory',
65
+ FacialHair = 'FacialHair',
66
+ Feet = 'Feet',
67
+ Hair = 'Hair',
68
+ Hands = 'Hands',
69
+ Head = 'Head',
70
+ HighPants = 'HighPants',
71
+ Hood = 'Hood',
72
+ LeftArm = 'LeftArm',
73
+ LeftLeg = 'LeftLeg',
74
+ Legs = 'Legs',
75
+ Mouth = 'Mouth',
76
+ Outerwear = 'Outerwear',
77
+ RightArm = 'RightArm',
78
+ RightLeg = 'RightLeg',
79
+ Skeleton = 'Skeleton',
80
+ Skin = 'Skin',
81
+ Top = 'Top',
82
+ }
83
+
46
84
  /**
47
85
  * Returns information about whether this fence is connected to
48
86
  * other fences in several directions.
@@ -537,6 +575,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
537
575
  * Direction to place the specified item within.
538
576
  * Defaults to: 1
539
577
  * @throws This function can throw errors.
578
+ *
579
+ * {@link GameTestError}
580
+ *
581
+ * {@link minecraftserver.InvalidEntityError}
540
582
  */
541
583
  breakBlock(blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction): boolean;
542
584
  /**
@@ -630,6 +672,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
630
672
  * Direction to place the specified item within.
631
673
  * Defaults to: 1
632
674
  * @throws This function can throw errors.
675
+ *
676
+ * {@link GameTestError}
677
+ *
678
+ * {@link minecraftserver.InvalidEntityError}
633
679
  */
634
680
  interactWithBlock(blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction): boolean;
635
681
  /**
@@ -642,6 +688,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
642
688
  * @param entity
643
689
  * Entity to interact with.
644
690
  * @throws This function can throw errors.
691
+ *
692
+ * {@link minecraftcommon.InvalidArgumentError}
693
+ *
694
+ * {@link minecraftserver.InvalidEntityError}
645
695
  */
646
696
  interactWithEntity(entity: minecraftserver.Entity): boolean;
647
697
  /**
@@ -665,6 +715,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
665
715
  * @param duration
666
716
  * Defaults to: 2
667
717
  * @throws This function can throw errors.
718
+ *
719
+ * {@link GameTestError}
720
+ *
721
+ * {@link minecraftserver.InvalidEntityError}
668
722
  */
669
723
  lookAtBlock(blockLocation: minecraftserver.Vector3, duration?: LookDuration): void;
670
724
  /**
@@ -736,6 +790,12 @@ export class SimulatedPlayer extends minecraftserver.Player {
736
790
  * This function can't be called in read-only mode.
737
791
  *
738
792
  * @throws This function can throw errors.
793
+ *
794
+ * {@link Error}
795
+ *
796
+ * {@link GameTestError}
797
+ *
798
+ * {@link minecraftserver.InvalidEntityError}
739
799
  */
740
800
  moveToLocation(location: minecraftserver.Vector3, options?: MoveToOptions): void;
741
801
  /**
@@ -752,6 +812,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
752
812
  * @param speed
753
813
  * Defaults to: 1
754
814
  * @throws This function can throw errors.
815
+ *
816
+ * {@link GameTestError}
817
+ *
818
+ * {@link minecraftserver.InvalidEntityError}
755
819
  */
756
820
  navigateToBlock(blockLocation: minecraftserver.Vector3, speed?: number): NavigationResult;
757
821
  /**
@@ -765,6 +829,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
765
829
  * @param speed
766
830
  * Defaults to: 1
767
831
  * @throws This function can throw errors.
832
+ *
833
+ * {@link minecraftcommon.InvalidArgumentError}
834
+ *
835
+ * {@link minecraftserver.InvalidEntityError}
768
836
  */
769
837
  navigateToEntity(entity: minecraftserver.Entity, speed?: number): NavigationResult;
770
838
  /**
@@ -781,6 +849,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
781
849
  * @param speed
782
850
  * Defaults to: 1
783
851
  * @throws This function can throw errors.
852
+ *
853
+ * {@link GameTestError}
854
+ *
855
+ * {@link minecraftserver.InvalidEntityError}
784
856
  */
785
857
  navigateToLocation(location: minecraftserver.Vector3, speed?: number): NavigationResult;
786
858
  /**
@@ -797,6 +869,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
797
869
  * Net speed to use for doing the navigation.
798
870
  * Defaults to: 1
799
871
  * @throws This function can throw errors.
872
+ *
873
+ * {@link GameTestError}
874
+ *
875
+ * {@link minecraftserver.InvalidEntityError}
800
876
  */
801
877
  navigateToLocations(locations: minecraftserver.Vector3[], speed?: number): void;
802
878
  /**
@@ -844,6 +920,19 @@ export class SimulatedPlayer extends minecraftserver.Player {
844
920
  * @throws This function can throw errors.
845
921
  */
846
922
  setItem(itemStack: minecraftserver.ItemStack, slot: number, selectSlot?: boolean): boolean;
923
+ /**
924
+ * @remarks
925
+ * Updates information about the player's skin.
926
+ *
927
+ * This function can't be called in read-only mode.
928
+ *
929
+ * @param options
930
+ * Options for the skin to set on the player.
931
+ * @throws This function can throw errors.
932
+ *
933
+ * {@link minecraftserver.InvalidEntityError}
934
+ */
935
+ setSkin(options: PlayerSkinData): void;
847
936
  /**
848
937
  * @remarks
849
938
  * This function can't be called in read-only mode.
@@ -980,6 +1069,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
980
1069
  * block where the item is placed.
981
1070
  * Defaults to: null
982
1071
  * @throws This function can throw errors.
1072
+ *
1073
+ * {@link GameTestError}
1074
+ *
1075
+ * {@link minecraftserver.InvalidEntityError}
983
1076
  */
984
1077
  useItemInSlotOnBlock(
985
1078
  slot: number,
@@ -1007,6 +1100,10 @@ export class SimulatedPlayer extends minecraftserver.Player {
1007
1100
  * block where the item is placed.
1008
1101
  * Defaults to: null
1009
1102
  * @throws This function can throw errors.
1103
+ *
1104
+ * {@link GameTestError}
1105
+ *
1106
+ * {@link minecraftserver.InvalidEntityError}
1010
1107
  */
1011
1108
  useItemOnBlock(
1012
1109
  itemStack: minecraftserver.ItemStack,
@@ -1073,6 +1170,8 @@ export class Test {
1073
1170
  * to true.
1074
1171
  * @throws This function can throw errors.
1075
1172
  *
1173
+ * {@link GameTestCompletedError}
1174
+ *
1076
1175
  * {@link GameTestError}
1077
1176
  */
1078
1177
  assert(condition: boolean, message: string): void;
@@ -1092,6 +1191,8 @@ export class Test {
1092
1191
  * Defaults to: true
1093
1192
  * @throws This function can throw errors.
1094
1193
  *
1194
+ * {@link GameTestCompletedError}
1195
+ *
1095
1196
  * {@link GameTestError}
1096
1197
  */
1097
1198
  assertBlockPresent(
@@ -1112,6 +1213,8 @@ export class Test {
1112
1213
  * the block at the specified location.
1113
1214
  * @throws This function can throw errors.
1114
1215
  *
1216
+ * {@link GameTestCompletedError}
1217
+ *
1115
1218
  * {@link GameTestError}
1116
1219
  */
1117
1220
  assertBlockState(blockLocation: minecraftserver.Vector3, callback: (arg0: minecraftserver.Block) => boolean): void;
@@ -1133,6 +1236,8 @@ export class Test {
1133
1236
  * Defaults to: true
1134
1237
  * @throws This function can throw errors.
1135
1238
  *
1239
+ * {@link GameTestCompletedError}
1240
+ *
1136
1241
  * {@link GameTestError}
1137
1242
  */
1138
1243
  assertCanReachLocation(
@@ -1155,6 +1260,8 @@ export class Test {
1155
1260
  * chest) to test the contents of.
1156
1261
  * @throws This function can throw errors.
1157
1262
  *
1263
+ * {@link GameTestCompletedError}
1264
+ *
1158
1265
  * {@link GameTestError}
1159
1266
  */
1160
1267
  assertContainerContains(itemStack: minecraftserver.ItemStack, blockLocation: minecraftserver.Vector3): void;
@@ -1168,6 +1275,8 @@ export class Test {
1168
1275
  * chest) to test is empty of contents.
1169
1276
  * @throws This function can throw errors.
1170
1277
  *
1278
+ * {@link GameTestCompletedError}
1279
+ *
1171
1280
  * {@link GameTestError}
1172
1281
  */
1173
1282
  assertContainerEmpty(blockLocation: minecraftserver.Vector3): void;
@@ -1193,6 +1302,8 @@ export class Test {
1193
1302
  * Defaults to: true
1194
1303
  * @throws This function can throw errors.
1195
1304
  *
1305
+ * {@link GameTestCompletedError}
1306
+ *
1196
1307
  * {@link GameTestError}
1197
1308
  */
1198
1309
  assertEntityHasArmor(
@@ -1224,6 +1335,8 @@ export class Test {
1224
1335
  * Defaults to: true
1225
1336
  * @throws This function can throw errors.
1226
1337
  *
1338
+ * {@link GameTestCompletedError}
1339
+ *
1227
1340
  * {@link GameTestError}
1228
1341
  */
1229
1342
  assertEntityHasComponent(
@@ -1249,6 +1362,8 @@ export class Test {
1249
1362
  * Defaults to: true
1250
1363
  * @throws This function can throw errors.
1251
1364
  *
1365
+ * {@link GameTestCompletedError}
1366
+ *
1252
1367
  * {@link GameTestError}
1253
1368
  */
1254
1369
  assertEntityInstancePresent(
@@ -1270,6 +1385,8 @@ export class Test {
1270
1385
  * Defaults to: true
1271
1386
  * @throws This function can throw errors.
1272
1387
  *
1388
+ * {@link GameTestCompletedError}
1389
+ *
1273
1390
  * {@link GameTestError}
1274
1391
  * @example simpleMobTest.ts
1275
1392
  * ```typescript
@@ -1318,6 +1435,8 @@ export class Test {
1318
1435
  * Defaults to: true
1319
1436
  * @throws This function can throw errors.
1320
1437
  *
1438
+ * {@link GameTestCompletedError}
1439
+ *
1321
1440
  * {@link GameTestError}
1322
1441
  */
1323
1442
  assertEntityPresent(
@@ -1342,6 +1461,8 @@ export class Test {
1342
1461
  * Defaults to: true
1343
1462
  * @throws This function can throw errors.
1344
1463
  *
1464
+ * {@link GameTestCompletedError}
1465
+ *
1345
1466
  * {@link GameTestError}
1346
1467
  * @example simpleMobTest.ts
1347
1468
  * ```typescript
@@ -1405,6 +1526,8 @@ export class Test {
1405
1526
  * is thrown.
1406
1527
  * @throws This function can throw errors.
1407
1528
  *
1529
+ * {@link GameTestCompletedError}
1530
+ *
1408
1531
  * {@link GameTestError}
1409
1532
  */
1410
1533
  assertEntityState(
@@ -1431,6 +1554,8 @@ export class Test {
1431
1554
  * Defaults to: true
1432
1555
  * @throws This function can throw errors.
1433
1556
  *
1557
+ * {@link GameTestCompletedError}
1558
+ *
1434
1559
  * {@link GameTestError}
1435
1560
  */
1436
1561
  assertEntityTouching(entityTypeIdentifier: string, location: minecraftserver.Vector3, isTouching?: boolean): void;
@@ -1449,6 +1574,8 @@ export class Test {
1449
1574
  * Defaults to: true
1450
1575
  * @throws This function can throw errors.
1451
1576
  *
1577
+ * {@link GameTestCompletedError}
1578
+ *
1452
1579
  * {@link GameTestError}
1453
1580
  */
1454
1581
  assertIsWaterlogged(blockLocation: minecraftserver.Vector3, isWaterlogged?: boolean): void;
@@ -1468,6 +1595,8 @@ export class Test {
1468
1595
  * Number of items, at minimum, to look and test for.
1469
1596
  * @throws This function can throw errors.
1470
1597
  *
1598
+ * {@link GameTestCompletedError}
1599
+ *
1471
1600
  * {@link GameTestError}
1472
1601
  */
1473
1602
  assertItemEntityCountIs(
@@ -1497,6 +1626,8 @@ export class Test {
1497
1626
  * Defaults to: true
1498
1627
  * @throws This function can throw errors.
1499
1628
  *
1629
+ * {@link GameTestCompletedError}
1630
+ *
1500
1631
  * {@link GameTestError}
1501
1632
  */
1502
1633
  assertItemEntityPresent(
@@ -1516,6 +1647,8 @@ export class Test {
1516
1647
  * Expected power level.
1517
1648
  * @throws This function can throw errors.
1518
1649
  *
1650
+ * {@link GameTestCompletedError}
1651
+ *
1519
1652
  * {@link GameTestError}
1520
1653
  */
1521
1654
  assertRedstonePower(blockLocation: minecraftserver.Vector3, power: number): void;
@@ -1532,6 +1665,8 @@ export class Test {
1532
1665
  * Defaults to: false
1533
1666
  * @throws This function can throw errors.
1534
1667
  *
1668
+ * {@link GameTestCompletedError}
1669
+ *
1535
1670
  * {@link GameTestError}
1536
1671
  */
1537
1672
  destroyBlock(blockLocation: minecraftserver.Vector3, dropResources?: boolean): void;
@@ -1566,6 +1701,8 @@ export class Test {
1566
1701
  * Location of the block to retrieve.
1567
1702
  * @throws This function can throw errors.
1568
1703
  *
1704
+ * {@link GameTestCompletedError}
1705
+ *
1569
1706
  * {@link GameTestError}
1570
1707
  */
1571
1708
  getBlock(blockLocation: minecraftserver.Vector3): minecraftserver.Block;
@@ -1575,6 +1712,8 @@ export class Test {
1575
1712
  *
1576
1713
  * @throws This function can throw errors.
1577
1714
  *
1715
+ * {@link GameTestCompletedError}
1716
+ *
1578
1717
  * {@link GameTestError}
1579
1718
  */
1580
1719
  getDimension(): minecraftserver.Dimension;
@@ -1590,6 +1729,8 @@ export class Test {
1590
1729
  * Location of the block to retrieve.
1591
1730
  * @throws This function can throw errors.
1592
1731
  *
1732
+ * {@link GameTestCompletedError}
1733
+ *
1593
1734
  * {@link GameTestError}
1594
1735
  */
1595
1736
  getFenceConnectivity(blockLocation: minecraftserver.Vector3): FenceConnectivity;
@@ -1607,6 +1748,8 @@ export class Test {
1607
1748
  * is present on the block.
1608
1749
  * @throws This function can throw errors.
1609
1750
  *
1751
+ * {@link GameTestCompletedError}
1752
+ *
1610
1753
  * {@link GameTestError}
1611
1754
  */
1612
1755
  getSculkSpreader(blockLocation: minecraftserver.Vector3): SculkSpreader | undefined;
@@ -1616,6 +1759,9 @@ export class Test {
1616
1759
  * minecraftserver.Direction} enum for more information on
1617
1760
  * potential values (north, east, south, west - values 2-5).
1618
1761
  *
1762
+ * @throws This function can throw errors.
1763
+ *
1764
+ * {@link GameTestCompletedError}
1619
1765
  */
1620
1766
  getTestDirection(): minecraftserver.Direction;
1621
1767
  /**
@@ -1627,8 +1773,28 @@ export class Test {
1627
1773
  *
1628
1774
  * @param tickDelay
1629
1775
  * Amount of time to wait, in ticks.
1776
+ * @throws This function can throw errors.
1777
+ *
1778
+ * {@link GameTestCompletedError}
1630
1779
  */
1631
1780
  idle(tickDelay: number): Promise<void>;
1781
+ /**
1782
+ * @remarks
1783
+ * Returns whether or not the test is currently in the Clean Up
1784
+ * step after running.
1785
+ *
1786
+ * This function can't be called in read-only mode.
1787
+ *
1788
+ */
1789
+ isCleaningUp(): boolean;
1790
+ /**
1791
+ * @remarks
1792
+ * Returns whether or not the test has already completed
1793
+ *
1794
+ * This function can't be called in read-only mode.
1795
+ *
1796
+ */
1797
+ isCompleted(): boolean;
1632
1798
  /**
1633
1799
  * @remarks
1634
1800
  * Kills all entities within the GameTest structure.
@@ -1637,6 +1803,8 @@ export class Test {
1637
1803
  *
1638
1804
  * @throws This function can throw errors.
1639
1805
  *
1806
+ * {@link GameTestCompletedError}
1807
+ *
1640
1808
  * {@link GameTestError}
1641
1809
  */
1642
1810
  killAllEntities(): void;
@@ -1646,6 +1814,8 @@ export class Test {
1646
1814
  *
1647
1815
  * @throws This function can throw errors.
1648
1816
  *
1817
+ * {@link GameTestCompletedError}
1818
+ *
1649
1819
  * {@link GameTestError}
1650
1820
  */
1651
1821
  onPlayerJump(mob: minecraftserver.Entity, jumpAmount: number): void;
@@ -1661,6 +1831,8 @@ export class Test {
1661
1831
  * Will throw an error if a button is not present at the
1662
1832
  * specified position.
1663
1833
  *
1834
+ * {@link GameTestCompletedError}
1835
+ *
1664
1836
  * {@link GameTestError}
1665
1837
  */
1666
1838
  pressButton(blockLocation: minecraftserver.Vector3): void;
@@ -1674,6 +1846,8 @@ export class Test {
1674
1846
  * Message to display.
1675
1847
  * @throws This function can throw errors.
1676
1848
  *
1849
+ * {@link GameTestCompletedError}
1850
+ *
1677
1851
  * {@link GameTestError}
1678
1852
  */
1679
1853
  print(text: string): void;
@@ -1689,6 +1863,8 @@ export class Test {
1689
1863
  * Will throw an error if a lever is not present at the
1690
1864
  * specified position.
1691
1865
  *
1866
+ * {@link GameTestCompletedError}
1867
+ *
1692
1868
  * {@link GameTestError}
1693
1869
  */
1694
1870
  pullLever(blockLocation: minecraftserver.Vector3): void;
@@ -1705,6 +1881,8 @@ export class Test {
1705
1881
  * Number of ticks to pulse Redstone.
1706
1882
  * @throws This function can throw errors.
1707
1883
  *
1884
+ * {@link GameTestCompletedError}
1885
+ *
1708
1886
  * {@link GameTestError}
1709
1887
  */
1710
1888
  pulseRedstone(blockLocation: minecraftserver.Vector3, duration: number): void;
@@ -1723,6 +1901,8 @@ export class Test {
1723
1901
  * A location relative to the GameTest command block.
1724
1902
  * @throws This function can throw errors.
1725
1903
  *
1904
+ * {@link GameTestCompletedError}
1905
+ *
1726
1906
  * {@link GameTestError}
1727
1907
  */
1728
1908
  relativeBlockLocation(worldBlockLocation: minecraftserver.Vector3): minecraftserver.Vector3;
@@ -1743,6 +1923,8 @@ export class Test {
1743
1923
  * A location relative to the GameTest command block.
1744
1924
  * @throws This function can throw errors.
1745
1925
  *
1926
+ * {@link GameTestCompletedError}
1927
+ *
1746
1928
  * {@link GameTestError}
1747
1929
  */
1748
1930
  relativeLocation(worldLocation: minecraftserver.Vector3): minecraftserver.Vector3;
@@ -1754,6 +1936,9 @@ export class Test {
1754
1936
  *
1755
1937
  * @param simulatedPlayer
1756
1938
  * Simulated player to remove.
1939
+ * @throws This function can throw errors.
1940
+ *
1941
+ * {@link GameTestCompletedError}
1757
1942
  */
1758
1943
  removeSimulatedPlayer(simulatedPlayer: SimulatedPlayer): void;
1759
1944
  /**
@@ -1772,6 +1957,8 @@ export class Test {
1772
1957
  * opposite of the test direction, and so on.
1773
1958
  * @throws This function can throw errors.
1774
1959
  *
1960
+ * {@link GameTestCompletedError}
1961
+ *
1775
1962
  * {@link GameTestError}
1776
1963
  */
1777
1964
  rotateDirection(direction: minecraftserver.Direction): minecraftserver.Direction;
@@ -1781,6 +1968,8 @@ export class Test {
1781
1968
  *
1782
1969
  * @throws This function can throw errors.
1783
1970
  *
1971
+ * {@link GameTestCompletedError}
1972
+ *
1784
1973
  * {@link GameTestError}
1785
1974
  */
1786
1975
  rotateVector(vector: minecraftserver.Vector3): minecraftserver.Vector3;
@@ -1813,6 +2002,22 @@ export class Test {
1813
2002
  * @throws This function can throw errors.
1814
2003
  */
1815
2004
  runAtTickTime(tick: number, callback: () => void): void;
2005
+ /**
2006
+ * @remarks
2007
+ * Runs the given callback after the GameTest has completed
2008
+ * regardless if the test passed, failed, or timed out.
2009
+ *
2010
+ * This function can't be called in read-only mode.
2011
+ *
2012
+ * @param callback
2013
+ * Callback to execute.
2014
+ * @throws This function can throw errors.
2015
+ *
2016
+ * {@link GameTestCompletedError}
2017
+ *
2018
+ * {@link GameTestError}
2019
+ */
2020
+ runOnFinish(callback: () => void): void;
1816
2021
  /**
1817
2022
  * @remarks
1818
2023
  * Sets a block to a particular configuration (a
@@ -1827,6 +2032,8 @@ export class Test {
1827
2032
  * Location of the block to set.
1828
2033
  * @throws This function can throw errors.
1829
2034
  *
2035
+ * {@link GameTestCompletedError}
2036
+ *
1830
2037
  * {@link GameTestError}
1831
2038
  */
1832
2039
  setBlockPermutation(blockData: minecraftserver.BlockPermutation, blockLocation: minecraftserver.Vector3): void;
@@ -1843,6 +2050,8 @@ export class Test {
1843
2050
  * Location of the block to set.
1844
2051
  * @throws This function can throw errors.
1845
2052
  *
2053
+ * {@link GameTestCompletedError}
2054
+ *
1846
2055
  * {@link GameTestError}
1847
2056
  * @example minibiomes.ts
1848
2057
  * ```typescript
@@ -1880,6 +2089,8 @@ export class Test {
1880
2089
  * for a list of values.
1881
2090
  * @throws This function can throw errors.
1882
2091
  *
2092
+ * {@link GameTestCompletedError}
2093
+ *
1883
2094
  * {@link GameTestError}
1884
2095
  */
1885
2096
  setFluidContainer(location: minecraftserver.Vector3, type: minecraftserver.FluidType): void;
@@ -1895,6 +2106,8 @@ export class Test {
1895
2106
  * Length of time, in ticks, before the entity explodes.
1896
2107
  * @throws This function can throw errors.
1897
2108
  *
2109
+ * {@link GameTestCompletedError}
2110
+ *
1898
2111
  * {@link GameTestError}
1899
2112
  */
1900
2113
  setTntFuse(entity: minecraftserver.Entity, fuseLength: number): void;
@@ -1914,6 +2127,8 @@ export class Test {
1914
2127
  * undefined.
1915
2128
  * @throws This function can throw errors.
1916
2129
  *
2130
+ * {@link GameTestCompletedError}
2131
+ *
1917
2132
  * {@link GameTestError}
1918
2133
  * @example simpleMobTest.ts
1919
2134
  * ```typescript
@@ -2009,6 +2224,8 @@ export class Test {
2009
2224
  * undefined.
2010
2225
  * @throws This function can throw errors.
2011
2226
  *
2227
+ * {@link GameTestCompletedError}
2228
+ *
2012
2229
  * {@link GameTestError}
2013
2230
  */
2014
2231
  spawnAtLocation(entityTypeIdentifier: string, location: minecraftserver.Vector3): minecraftserver.Entity;
@@ -2024,6 +2241,8 @@ export class Test {
2024
2241
  * Location to create the item entity at.
2025
2242
  * @throws This function can throw errors.
2026
2243
  *
2244
+ * {@link GameTestCompletedError}
2245
+ *
2027
2246
  * {@link GameTestError}
2028
2247
  */
2029
2248
  spawnItem(itemStack: minecraftserver.ItemStack, location: minecraftserver.Vector3): minecraftserver.Entity;
@@ -2042,6 +2261,8 @@ export class Test {
2042
2261
  * Defaults to: 0
2043
2262
  * @throws This function can throw errors.
2044
2263
  *
2264
+ * {@link GameTestCompletedError}
2265
+ *
2045
2266
  * {@link GameTestError}
2046
2267
  */
2047
2268
  spawnSimulatedPlayer(
@@ -2061,6 +2282,8 @@ export class Test {
2061
2282
  * Location where the entity should be spawned.
2062
2283
  * @throws This function can throw errors.
2063
2284
  *
2285
+ * {@link GameTestCompletedError}
2286
+ *
2064
2287
  * {@link GameTestError}
2065
2288
  */
2066
2289
  spawnWithoutBehaviors(entityTypeIdentifier: string, blockLocation: minecraftserver.Vector3): minecraftserver.Entity;
@@ -2076,6 +2299,8 @@ export class Test {
2076
2299
  * Location where the entity should be spawned.
2077
2300
  * @throws This function can throw errors.
2078
2301
  *
2302
+ * {@link GameTestCompletedError}
2303
+ *
2079
2304
  * {@link GameTestError}
2080
2305
  */
2081
2306
  spawnWithoutBehaviorsAtLocation(
@@ -2098,6 +2323,8 @@ export class Test {
2098
2323
  * specify a direction.
2099
2324
  * @throws This function can throw errors.
2100
2325
  *
2326
+ * {@link GameTestCompletedError}
2327
+ *
2101
2328
  * {@link GameTestError}
2102
2329
  */
2103
2330
  spreadFromFaceTowardDirection(
@@ -2115,6 +2342,9 @@ export class Test {
2115
2342
  * @returns
2116
2343
  * A new GameTestSequence with chaining methods that facilitate
2117
2344
  * creating a set of steps.
2345
+ * @throws This function can throw errors.
2346
+ *
2347
+ * {@link GameTestCompletedError}
2118
2348
  */
2119
2349
  startSequence(): GameTestSequence;
2120
2350
  /**
@@ -2224,6 +2454,8 @@ export class Test {
2224
2454
  * Defaults to: true
2225
2455
  * @throws This function can throw errors.
2226
2456
  *
2457
+ * {@link GameTestCompletedError}
2458
+ *
2227
2459
  * {@link GameTestError}
2228
2460
  */
2229
2461
  succeedWhenBlockPresent(
@@ -2337,6 +2569,8 @@ export class Test {
2337
2569
  * Defaults to: []
2338
2570
  * @throws This function can throw errors.
2339
2571
  *
2572
+ * {@link GameTestCompletedError}
2573
+ *
2340
2574
  * {@link GameTestError}
2341
2575
  */
2342
2576
  triggerInternalBlockEvent(blockLocation: minecraftserver.Vector3, event: string, eventParameters?: number[]): void;
@@ -2351,6 +2585,9 @@ export class Test {
2351
2585
  *
2352
2586
  * @param callback
2353
2587
  * Function with code to evaluate.
2588
+ * @throws This function can throw errors.
2589
+ *
2590
+ * {@link GameTestCompletedError}
2354
2591
  */
2355
2592
  until(callback: () => void): Promise<void>;
2356
2593
  /**
@@ -2371,6 +2608,8 @@ export class Test {
2371
2608
  * Defaults to: 1
2372
2609
  * @throws This function can throw errors.
2373
2610
  *
2611
+ * {@link GameTestCompletedError}
2612
+ *
2374
2613
  * {@link GameTestError}
2375
2614
  */
2376
2615
  walkTo(mob: minecraftserver.Entity, blockLocation: minecraftserver.Vector3, speedModifier?: number): void;
@@ -2392,6 +2631,8 @@ export class Test {
2392
2631
  * Defaults to: 1
2393
2632
  * @throws This function can throw errors.
2394
2633
  *
2634
+ * {@link GameTestCompletedError}
2635
+ *
2395
2636
  * {@link GameTestError}
2396
2637
  */
2397
2638
  walkToLocation(mob: minecraftserver.Entity, location: minecraftserver.Vector3, speedModifier?: number): void;
@@ -2408,6 +2649,8 @@ export class Test {
2408
2649
  * An absolute location relative to the GameTest command block.
2409
2650
  * @throws This function can throw errors.
2410
2651
  *
2652
+ * {@link GameTestCompletedError}
2653
+ *
2411
2654
  * {@link GameTestError}
2412
2655
  */
2413
2656
  worldBlockLocation(relativeBlockLocation: minecraftserver.Vector3): minecraftserver.Vector3;
@@ -2424,6 +2667,8 @@ export class Test {
2424
2667
  * An absolute location relative to the GameTest command block.
2425
2668
  * @throws This function can throw errors.
2426
2669
  *
2670
+ * {@link GameTestCompletedError}
2671
+ *
2427
2672
  * {@link GameTestError}
2428
2673
  */
2429
2674
  worldLocation(relativeLocation: minecraftserver.Vector3): minecraftserver.Vector3;
@@ -2440,6 +2685,37 @@ export interface MoveToOptions {
2440
2685
  speed?: number;
2441
2686
  }
2442
2687
 
2688
+ /**
2689
+ * Data pertaining to a specific player Persona piece.
2690
+ */
2691
+ export interface PlayerPersonaPiece {
2692
+ id: string;
2693
+ isDefaultPiece?: boolean;
2694
+ packId: string;
2695
+ productId: string;
2696
+ type: PersonaPieceType;
2697
+ }
2698
+
2699
+ /**
2700
+ * Data pertaining to a player's configured skin.
2701
+ */
2702
+ export interface PlayerSkinData {
2703
+ armSize?: PersonaArmSize;
2704
+ personaPieces?: PlayerPersonaPiece[];
2705
+ skinColor?: minecraftserver.RGB;
2706
+ }
2707
+
2708
+ // @ts-ignore Class inheritance allowed for native defined classes
2709
+ export class GameTestCompletedError extends Error {
2710
+ private constructor();
2711
+ /**
2712
+ * @remarks
2713
+ * This property can be read in early-execution mode.
2714
+ *
2715
+ */
2716
+ reason: GameTestCompletedErrorReason;
2717
+ }
2718
+
2443
2719
  // @ts-ignore Class inheritance allowed for native defined classes
2444
2720
  export class GameTestError extends Error {
2445
2721
  private constructor();
@@ -2463,6 +2739,21 @@ export class GameTestError extends Error {
2463
2739
  type: GameTestErrorType;
2464
2740
  }
2465
2741
 
2742
+ /**
2743
+ * @remarks
2744
+ * Returns data about a player's skin.
2745
+ *
2746
+ * This function can't be called in read-only mode.
2747
+ *
2748
+ * @param player
2749
+ * The player who's skin is returned.
2750
+ * @throws This function can throw errors.
2751
+ *
2752
+ * {@link minecraftcommon.InvalidArgumentError}
2753
+ *
2754
+ * {@link minecraftserver.InvalidEntityError}
2755
+ */
2756
+ export function getPlayerSkin(player: minecraftserver.Player): PlayerSkinData;
2466
2757
  /**
2467
2758
  * @remarks
2468
2759
  * Registers a new GameTest function. This GameTest will become
@@ -2556,3 +2847,58 @@ export function registerAsync(
2556
2847
  testName: string,
2557
2848
  testFunction: (arg0: Test) => Promise<void>,
2558
2849
  ): RegistrationBuilder;
2850
+ /**
2851
+ * @remarks
2852
+ * Sets a callback that is called after the batch gets called.
2853
+ * This will overwrite previously set callbacks for this batch.
2854
+ *
2855
+ * This function can't be called in read-only mode.
2856
+ *
2857
+ * This function can be called in early-execution mode.
2858
+ *
2859
+ * @param batchName
2860
+ * Name of the batch of tests the callback will run after.
2861
+ * @throws This function can throw errors.
2862
+ *
2863
+ * {@link GameTestError}
2864
+ */
2865
+ export function setAfterBatchCallback(batchName: string, batchCallback: () => void): void;
2866
+ /**
2867
+ * @remarks
2868
+ * Sets a callback that is called before the batch gets called.
2869
+ * This will overwrite previously set callbacks for this batch.
2870
+ *
2871
+ * This function can't be called in read-only mode.
2872
+ *
2873
+ * This function can be called in early-execution mode.
2874
+ *
2875
+ * @param batchName
2876
+ * Name of the batch of tests the callback will run before.
2877
+ * @throws This function can throw errors.
2878
+ *
2879
+ * {@link GameTestError}
2880
+ */
2881
+ export function setBeforeBatchCallback(batchName: string, batchCallback: () => void): void;
2882
+ /**
2883
+ * @remarks
2884
+ * Spawns a simulated player that isn't associated to a
2885
+ * specific {@link Test}. You can use {@link
2886
+ * SimulatedPlayer.remove} to remove the player from the world.
2887
+ *
2888
+ * This function can't be called in read-only mode.
2889
+ *
2890
+ * @param location
2891
+ * The location in which to spawn the player.
2892
+ * @param name
2893
+ * The name for the player.
2894
+ * @param gameMode
2895
+ * The game mode for the player.
2896
+ * @throws This function can throw errors.
2897
+ *
2898
+ * {@link minecraftcommon.EngineError}
2899
+ */
2900
+ export function spawnSimulatedPlayer(
2901
+ location: minecraftserver.DimensionLocation,
2902
+ name: string,
2903
+ gameMode: minecraftserver.GameMode,
2904
+ ): SimulatedPlayer;
package/package.json CHANGED
@@ -1,20 +1,20 @@
1
- {
2
- "name": "@minecraft/server-gametest",
3
- "version": "1.0.0-beta.1.21.95-stable",
4
- "description": "",
5
- "contributors": [
6
- {
7
- "name": "Jake Shirley",
8
- "email": "jake@xbox.com"
9
- },
10
- {
11
- "name": "Mike Ammerlaan",
12
- "email": "mikeam@microsoft.com"
13
- }
14
- ],
15
- "dependencies": {
16
- "@minecraft/common": "^1.0.0",
17
- "@minecraft/server": "^1.17.0 || ^2.0.0"
18
- },
19
- "license": "MIT"
1
+ {
2
+ "name": "@minecraft/server-gametest",
3
+ "version": "1.0.0-beta.1.26.0-preview.24",
4
+ "description": "",
5
+ "contributors": [
6
+ {
7
+ "name": "Jake Shirley",
8
+ "email": "jake@xbox.com"
9
+ },
10
+ {
11
+ "name": "Mike Ammerlaan",
12
+ "email": "mikeam@microsoft.com"
13
+ }
14
+ ],
15
+ "peerDependencies": {
16
+ "@minecraft/common": "^1.0.0",
17
+ "@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.6.0-beta.1.26.0-preview.24"
18
+ },
19
+ "license": "MIT"
20
20
  }