@minecraft/server-gametest 1.0.0-beta.1.21.30-preview.21 → 1.0.0-beta.1.21.30-preview.23

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 (2) hide show
  1. package/index.d.ts +70 -0
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -24,6 +24,9 @@
24
24
  */
25
25
  import * as minecraftcommon from '@minecraft/common';
26
26
  import * as minecraftserver from '@minecraft/server';
27
+ /**
28
+ * @beta
29
+ */
27
30
  export enum GameTestErrorType {
28
31
  Assert = 'Assert',
29
32
  AssertAtPosition = 'AssertAtPosition',
@@ -37,6 +40,9 @@ export enum GameTestErrorType {
37
40
  Waiting = 'Waiting',
38
41
  }
39
42
 
43
+ /**
44
+ * @beta
45
+ */
40
46
  export enum LookDuration {
41
47
  Continuous = 'Continuous',
42
48
  Instant = 'Instant',
@@ -44,6 +50,7 @@ export enum LookDuration {
44
50
  }
45
51
 
46
52
  /**
53
+ * @beta
47
54
  * Returns information about whether this fence is connected to
48
55
  * other fences in several directions.
49
56
  */
@@ -80,6 +87,7 @@ export class FenceConnectivity {
80
87
  }
81
88
 
82
89
  /**
90
+ * @beta
83
91
  * Executes a set of steps defined via chained .thenXyz
84
92
  * methods, sequentially. This facilitates a 'script' of
85
93
  * GameTest setup methods and assertions over time.
@@ -203,6 +211,9 @@ export class GameTestSequence {
203
211
  thenWaitAfter(delayTicks: number, callback: () => void): GameTestSequence;
204
212
  }
205
213
 
214
+ /**
215
+ * @beta
216
+ */
206
217
  export class NavigationResult {
207
218
  private constructor();
208
219
  readonly isFullPath: boolean;
@@ -210,6 +221,7 @@ export class NavigationResult {
210
221
  }
211
222
 
212
223
  /**
224
+ * @beta
213
225
  * A utility class to set GameTest parameters for a test.
214
226
  * Methods can be chained together to set multiple properties.
215
227
  */
@@ -343,6 +355,7 @@ export class RegistrationBuilder {
343
355
  }
344
356
 
345
357
  /**
358
+ * @beta
346
359
  * Implements a class that can be used for testing sculk
347
360
  * spreading behaviors. This sculk spreader class can drive the
348
361
  * growth of sculk around a particular block.
@@ -408,6 +421,7 @@ export class SculkSpreader {
408
421
  export class SimulatedPlayer extends minecraftserver.Player {
409
422
  private constructor();
410
423
  /**
424
+ * @beta
411
425
  * @remarks
412
426
  * Rotation of the head across pitch and yaw angles.
413
427
  *
@@ -415,6 +429,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
415
429
  */
416
430
  readonly headRotation: minecraftserver.Vector2;
417
431
  /**
432
+ * @beta
418
433
  * @remarks
419
434
  * Returns whether the simulated player is sprinting.
420
435
  *
@@ -423,6 +438,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
423
438
  */
424
439
  isSprinting: boolean;
425
440
  /**
441
+ * @beta
426
442
  * @remarks
427
443
  * Causes the simulated player to make an attack 'swipe'.
428
444
  * Returns true if the attack was performed - for example, the
@@ -435,6 +451,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
435
451
  */
436
452
  attack(): boolean;
437
453
  /**
454
+ * @beta
438
455
  * @remarks
439
456
  * Causes the simulated player to attack the provided target.
440
457
  * Returns true if the attack was performed - for example, the
@@ -448,6 +465,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
448
465
  */
449
466
  attackEntity(entity: minecraftserver.Entity): boolean;
450
467
  /**
468
+ * @beta
451
469
  * @remarks
452
470
  * Destroys the block at blockLocation, respecting the rules of
453
471
  * the server player's game mode. The block will be hit until
@@ -464,6 +482,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
464
482
  */
465
483
  breakBlock(blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction): boolean;
466
484
  /**
485
+ * @beta
467
486
  * @remarks
468
487
  * This function can't be called in read-only mode.
469
488
  *
@@ -471,6 +490,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
471
490
  */
472
491
  chat(message: string): void;
473
492
  /**
493
+ * @beta
474
494
  * @remarks
475
495
  * Simulates and performs a disconnection of the simulated
476
496
  * player from the world.
@@ -481,6 +501,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
481
501
  */
482
502
  disconnect(): void;
483
503
  /**
504
+ * @beta
484
505
  * @remarks
485
506
  * Drops the simulated player's selected item
486
507
  *
@@ -490,6 +511,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
490
511
  */
491
512
  dropSelectedItem(): boolean;
492
513
  /**
514
+ * @beta
493
515
  * @remarks
494
516
  * Causes the simulated player to start flying as though they
495
517
  * were flying in creative mode. For flying with Elytra, see
@@ -501,6 +523,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
501
523
  */
502
524
  fly(): void;
503
525
  /**
526
+ * @beta
504
527
  * @remarks
505
528
  * Gives the simulated player a particular item stack.
506
529
  *
@@ -514,6 +537,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
514
537
  */
515
538
  giveItem(itemStack: minecraftserver.ItemStack, selectSlot?: boolean): boolean;
516
539
  /**
540
+ * @beta
517
541
  * @remarks
518
542
  * Causes the simulated player to start gliding. Elytra must be
519
543
  * equipped and the player must be in the air.
@@ -529,6 +553,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
529
553
  */
530
554
  glide(): boolean;
531
555
  /**
556
+ * @beta
532
557
  * @remarks
533
558
  * Performs a raycast from the player’s head and interacts with
534
559
  * the first intersected block or entity. Returns true if the
@@ -540,6 +565,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
540
565
  */
541
566
  interact(): boolean;
542
567
  /**
568
+ * @beta
543
569
  * @remarks
544
570
  * Causes the simulated player to interact with a block. The
545
571
  * block at the specified block location must be solid. Returns
@@ -555,6 +581,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
555
581
  */
556
582
  interactWithBlock(blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction): boolean;
557
583
  /**
584
+ * @beta
558
585
  * @remarks
559
586
  * Causes the simulated player to interact with a mob. Returns
560
587
  * true if the interaction was performed.
@@ -567,6 +594,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
567
594
  */
568
595
  interactWithEntity(entity: minecraftserver.Entity): boolean;
569
596
  /**
597
+ * @beta
570
598
  * @remarks
571
599
  * Causes the simulated player to jump.
572
600
  *
@@ -578,6 +606,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
578
606
  */
579
607
  jump(): boolean;
580
608
  /**
609
+ * @beta
581
610
  * @remarks
582
611
  * Rotates the simulated player's head/body to look at the
583
612
  * given block location.
@@ -588,6 +617,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
588
617
  */
589
618
  lookAtBlock(blockLocation: minecraftserver.Vector3, duration?: LookDuration): void;
590
619
  /**
620
+ * @beta
591
621
  * @remarks
592
622
  * Rotates the simulated player's head/body to look at the
593
623
  * given entity.
@@ -598,6 +628,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
598
628
  */
599
629
  lookAtEntity(entity: minecraftserver.Entity, duration?: LookDuration): void;
600
630
  /**
631
+ * @beta
601
632
  * @remarks
602
633
  * Rotates the simulated player's head/body to look at the
603
634
  * given location.
@@ -608,6 +639,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
608
639
  */
609
640
  lookAtLocation(location: minecraftserver.Vector3, duration?: LookDuration): void;
610
641
  /**
642
+ * @beta
611
643
  * @remarks
612
644
  * Orders the simulated player to walk in the given direction
613
645
  * relative to the GameTest.
@@ -618,6 +650,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
618
650
  */
619
651
  move(westEast: number, northSouth: number, speed?: number): void;
620
652
  /**
653
+ * @beta
621
654
  * @remarks
622
655
  * Orders the simulated player to walk in the given direction
623
656
  * relative to the player's current rotation.
@@ -628,6 +661,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
628
661
  */
629
662
  moveRelative(leftRight: number, backwardForward: number, speed?: number): void;
630
663
  /**
664
+ * @beta
631
665
  * @remarks
632
666
  * Orders the simulated player to move to the given block
633
667
  * location in a straight line. If a move or navigation is
@@ -640,6 +674,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
640
674
  */
641
675
  moveToBlock(blockLocation: minecraftserver.Vector3, options?: MoveToOptions): void;
642
676
  /**
677
+ * @beta
643
678
  * @remarks
644
679
  * Orders the simulated player to move to the given location in
645
680
  * a straight line. If a move or navigation is already playing,
@@ -651,6 +686,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
651
686
  */
652
687
  moveToLocation(location: minecraftserver.Vector3, options?: MoveToOptions): void;
653
688
  /**
689
+ * @beta
654
690
  * @remarks
655
691
  * Orders the simulated player to move to a specific block
656
692
  * location using navigation. If a move or navigation is
@@ -665,6 +701,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
665
701
  */
666
702
  navigateToBlock(blockLocation: minecraftserver.Vector3, speed?: number): NavigationResult;
667
703
  /**
704
+ * @beta
668
705
  * @remarks
669
706
  * Will use navigation to follow the selected entity to within
670
707
  * a one block radius. If a move or navigation is already
@@ -676,6 +713,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
676
713
  */
677
714
  navigateToEntity(entity: minecraftserver.Entity, speed?: number): NavigationResult;
678
715
  /**
716
+ * @beta
679
717
  * @remarks
680
718
  * Orders the simulated player to move to a specific location
681
719
  * using navigation. If a move or navigation is already
@@ -690,6 +728,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
690
728
  */
691
729
  navigateToLocation(location: minecraftserver.Vector3, speed?: number): NavigationResult;
692
730
  /**
731
+ * @beta
693
732
  * @remarks
694
733
  * Use navigation to follow the route provided via the
695
734
  * locations parameter. If a move or navigation is already
@@ -705,6 +744,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
705
744
  */
706
745
  navigateToLocations(locations: minecraftserver.Vector3[], speed?: number): void;
707
746
  /**
747
+ * @beta
708
748
  * @remarks
709
749
  * Respawns the particular simulated player.
710
750
  *
@@ -714,6 +754,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
714
754
  */
715
755
  respawn(): boolean;
716
756
  /**
757
+ * @beta
717
758
  * @remarks
718
759
  * Causes the simulated player to turn by the provided angle,
719
760
  * relative to the player's current rotation.
@@ -724,6 +765,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
724
765
  */
725
766
  rotateBody(angleInDegrees: number): void;
726
767
  /**
768
+ * @beta
727
769
  * @remarks
728
770
  * Causes the simulated player to turn to face the provided
729
771
  * angle, relative to the GameTest.
@@ -734,6 +776,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
734
776
  */
735
777
  setBodyRotation(angleInDegrees: number): void;
736
778
  /**
779
+ * @beta
737
780
  * @remarks
738
781
  * Sets a particular item for the simulated player.
739
782
  *
@@ -749,6 +792,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
749
792
  */
750
793
  setItem(itemStack: minecraftserver.ItemStack, slot: number, selectSlot?: boolean): boolean;
751
794
  /**
795
+ * @beta
752
796
  * @remarks
753
797
  * This function can't be called in read-only mode.
754
798
  *
@@ -756,6 +800,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
756
800
  */
757
801
  startBuild(slot?: number): void;
758
802
  /**
803
+ * @beta
759
804
  * @remarks
760
805
  * Stops destroying the block that is currently being hit.
761
806
  *
@@ -765,6 +810,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
765
810
  */
766
811
  stopBreakingBlock(): void;
767
812
  /**
813
+ * @beta
768
814
  * @remarks
769
815
  * This function can't be called in read-only mode.
770
816
  *
@@ -772,6 +818,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
772
818
  */
773
819
  stopBuild(): void;
774
820
  /**
821
+ * @beta
775
822
  * @remarks
776
823
  * Causes the simulated player to stop flying.
777
824
  *
@@ -781,6 +828,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
781
828
  */
782
829
  stopFlying(): void;
783
830
  /**
831
+ * @beta
784
832
  * @remarks
785
833
  * Causes the simulated player to stop gliding.
786
834
  *
@@ -790,6 +838,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
790
838
  */
791
839
  stopGliding(): void;
792
840
  /**
841
+ * @beta
793
842
  * @remarks
794
843
  * Stops interacting with entities or blocks.
795
844
  *
@@ -799,6 +848,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
799
848
  */
800
849
  stopInteracting(): void;
801
850
  /**
851
+ * @beta
802
852
  * @remarks
803
853
  * Stops moving/walking/following if the simulated player is
804
854
  * moving.
@@ -809,6 +859,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
809
859
  */
810
860
  stopMoving(): void;
811
861
  /**
862
+ * @beta
812
863
  * @remarks
813
864
  * Causes the simulated player to stop swimming.
814
865
  *
@@ -818,6 +869,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
818
869
  */
819
870
  stopSwimming(): void;
820
871
  /**
872
+ * @beta
821
873
  * @remarks
822
874
  * Stops using the currently active item.
823
875
  *
@@ -830,6 +882,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
830
882
  */
831
883
  stopUsingItem(): minecraftserver.ItemStack | undefined;
832
884
  /**
885
+ * @beta
833
886
  * @remarks
834
887
  * Causes the simulated player to start swimming.
835
888
  *
@@ -839,6 +892,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
839
892
  */
840
893
  swim(): void;
841
894
  /**
895
+ * @beta
842
896
  * @remarks
843
897
  * Causes the simulated player to use an item. Does not consume
844
898
  * the item. Returns false if the item is on cooldown.
@@ -851,6 +905,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
851
905
  */
852
906
  useItem(itemStack: minecraftserver.ItemStack): boolean;
853
907
  /**
908
+ * @beta
854
909
  * @remarks
855
910
  * Causes the simulated player to hold and use an item in their
856
911
  * inventory.
@@ -863,6 +918,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
863
918
  */
864
919
  useItemInSlot(slot: number): boolean;
865
920
  /**
921
+ * @beta
866
922
  * @remarks
867
923
  * Causes the simulated player to use an item in their
868
924
  * inventory on a block. The block at the specified block
@@ -888,6 +944,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
888
944
  faceLocation?: minecraftserver.Vector3,
889
945
  ): boolean;
890
946
  /**
947
+ * @beta
891
948
  * @remarks
892
949
  * Causes the simulated player to use an item on a block. The
893
950
  * block at the specified block location must be solid. Returns
@@ -915,6 +972,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
915
972
  }
916
973
 
917
974
  /**
975
+ * @beta
918
976
  * These well-known tags can be used to classify different
919
977
  * tests into suites to run.
920
978
  */
@@ -952,6 +1010,7 @@ export class Tags {
952
1010
  }
953
1011
 
954
1012
  /**
1013
+ * @beta
955
1014
  * Main class for GameTest functions, with helpers and data for
956
1015
  * manipulating the respective test. Note that all methods of
957
1016
  * this class expect BlockLocations and Locations relative to
@@ -2222,17 +2281,26 @@ export class Test {
2222
2281
  worldLocation(relativeLocation: minecraftserver.Vector3): minecraftserver.Vector3;
2223
2282
  }
2224
2283
 
2284
+ /**
2285
+ * @beta
2286
+ */
2225
2287
  export interface GameTestErrorContext {
2226
2288
  absolutePosition: minecraftserver.Vector3;
2227
2289
  relativePosition: minecraftserver.Vector3;
2228
2290
  tickCount: number;
2229
2291
  }
2230
2292
 
2293
+ /**
2294
+ * @beta
2295
+ */
2231
2296
  export interface MoveToOptions {
2232
2297
  faceTarget?: boolean;
2233
2298
  speed?: number;
2234
2299
  }
2235
2300
 
2301
+ /**
2302
+ * @beta
2303
+ */
2236
2304
  // @ts-ignore Class inheritance allowed for native defined classes
2237
2305
  export class GameTestError extends Error {
2238
2306
  private constructor();
@@ -2242,6 +2310,7 @@ export class GameTestError extends Error {
2242
2310
  }
2243
2311
 
2244
2312
  /**
2313
+ * @beta
2245
2314
  * @remarks
2246
2315
  * Registers a new GameTest function. This GameTest will become
2247
2316
  * available in Minecraft via /gametest run
@@ -2287,6 +2356,7 @@ export function register(
2287
2356
  testFunction: (arg: Test) => void,
2288
2357
  ): RegistrationBuilder;
2289
2358
  /**
2359
+ * @beta
2290
2360
  * @remarks
2291
2361
  * Registers a new GameTest function that is designed for
2292
2362
  * asynchronous execution. This GameTest will become available
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-gametest",
3
- "version": "1.0.0-beta.1.21.30-preview.21",
3
+ "version": "1.0.0-beta.1.21.30-preview.23",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {