@minecraft/server-gametest 1.0.0-beta.1.26.2-stable → 1.0.0-beta.1.26.20-preview.22

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/server-gametest`
-
-The @minecraft/server-gametest module provides scriptable APIs for scaffolding and testing content experiences in Minecraft.
-
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
-See full documentation for this module here:
-
+# `@minecraft/server-gametest`
+
+The @minecraft/server-gametest module provides scriptable APIs for scaffolding and testing content experiences in Minecraft.
+
+## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
+
+See full documentation for this module here:
+
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-gametest/minecraft-server-gametest

package/index.d.ts

@@ -409,8 +409,8 @@ export class RegistrationBuilder {
      * methods can be called.
      * @example phantomsShouldFlyFromCats.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function phantomsShouldFlyFromCats(test: Test) {
      *   test.spawn(MinecraftEntityTypes.Cat, { x: 4, y: 3, z: 3 });
@@ -419,8 +419,9 @@ export class RegistrationBuilder {
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Phantom, { x: 4, y: 6, z: 3 }, true);
      * }
      *
-     * register("MobBehaviorTests", "phantoms_should_fly_from_cats", phantomsShouldFlyFromCats)
-     *   .structureName("gametests:glass_cells");
+     * register('MobBehaviorTests', 'phantoms_should_fly_from_cats', phantomsShouldFlyFromCats).structureName(
+     *   'gametests:glass_cells'
+     * );
      * ```
      */
     structureName(structureName: string): RegistrationBuilder;
@@ -438,8 +439,8 @@ export class RegistrationBuilder {
      * methods can be called.
      * @example phantomsShouldFlyFromCats.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function phantomsShouldFlyFromCats(test: Test) {
      *   test.spawn(MinecraftEntityTypes.Cat, { x: 4, y: 3, z: 3 });
@@ -448,8 +449,9 @@ export class RegistrationBuilder {
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Phantom, { x: 4, y: 6, z: 3 }, true);
      * }
      *
-     * register("MobBehaviorTests", "phantoms_should_fly_from_cats", phantomsShouldFlyFromCats)
-     *   .structureName("gametests:glass_cells");
+     * register('MobBehaviorTests', 'phantoms_should_fly_from_cats', phantomsShouldFlyFromCats).structureName(
+     *   'gametests:glass_cells'
+     * );
      * ```
      */
     tag(tag: string): RegistrationBuilder;
@@ -754,6 +756,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
      *
      * @param speed
      * Defaults to: 1
+     * Bounds: [0, 1]
      * @throws This function can throw errors.
      */
     move(westEast: number, northSouth: number, speed?: number): void;
@@ -766,6 +769,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
      *
      * @param speed
      * Defaults to: 1
+     * Bounds: [0, 1]
      * @throws This function can throw errors.
      */
     moveRelative(leftRight: number, backwardForward: number, speed?: number): void;
@@ -811,6 +815,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
      *
      * @param speed
      * Defaults to: 1
+     * Bounds: [0, 1]
      * @throws This function can throw errors.
      *
      * {@link GameTestError}
@@ -828,6 +833,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
      *
      * @param speed
      * Defaults to: 1
+     * Bounds: [0, 1]
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
@@ -848,6 +854,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
      *
      * @param speed
      * Defaults to: 1
+     * Bounds: [0, 1]
      * @throws This function can throw errors.
      *
      * {@link GameTestError}
@@ -868,6 +875,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @param speed
      * Net speed to use for doing the navigation.
      * Defaults to: 1
+     * Bounds: [0, 1]
      * @throws This function can throw errors.
      *
      * {@link GameTestError}
@@ -1393,21 +1401,21 @@ export class Test {
      * import * as gameTest from '@minecraft/server-gametest';
      *
      * gameTest
-     *     .register('StarterTests', 'simpleMobTest', (test: gameTest.Test) => {
-     *         const attackerId = 'fox';
-     *         const victimId = 'chicken';
+     *   .register('StarterTests', 'simpleMobTest', (test: gameTest.Test) => {
+     *     const attackerId = 'fox';
+     *     const victimId = 'chicken';
      *
-     *         test.spawn(attackerId, { x: 5, y: 2, z: 5 });
-     *         const victim = test.spawn(victimId, { x: 2, y: 2, z: 2 });
+     *     test.spawn(attackerId, { x: 5, y: 2, z: 5 });
+     *     const victim = test.spawn(victimId, { x: 2, y: 2, z: 2 });
      *
-     *         test.assertEntityInstancePresentInArea(victim, true);
+     *     test.assertEntityInstancePresentInArea(victim, true);
      *
-     *         test.succeedWhen(() => {
-     *             test.assertEntityInstancePresentInArea(victim, false);
-     *         });
-     *     })
-     *     .maxTicks(400)
-     *     .structureName('gametests:mediumglass');
+     *     test.succeedWhen(() => {
+     *       test.assertEntityInstancePresentInArea(victim, false);
+     *     });
+     *   })
+     *   .maxTicks(400)
+     *   .structureName('gametests:mediumglass');
      * ```
      */
     assertEntityInstancePresentInArea(entity: minecraftserver.Entity, isPresent?: boolean): void;
@@ -1469,26 +1477,26 @@ export class Test {
      * import * as gameTest from '@minecraft/server-gametest';
      *
      * gameTest
-     *     .register('StarterTests', 'simpleMobTest', (test: gameTest.Test) => {
-     *         const attackerId = 'fox';
-     *         const victimId = 'chicken';
+     *   .register('StarterTests', 'simpleMobTest', (test: gameTest.Test) => {
+     *     const attackerId = 'fox';
+     *     const victimId = 'chicken';
      *
-     *         test.spawn(attackerId, { x: 5, y: 2, z: 5 });
-     *         test.spawn(victimId, { x: 2, y: 2, z: 2 });
+     *     test.spawn(attackerId, { x: 5, y: 2, z: 5 });
+     *     test.spawn(victimId, { x: 2, y: 2, z: 2 });
      *
-     *         test.assertEntityPresentInArea(victimId, true);
+     *     test.assertEntityPresentInArea(victimId, true);
      *
-     *         test.succeedWhen(() => {
-     *             test.assertEntityPresentInArea(victimId, false);
-     *         });
-     *     })
-     *     .maxTicks(400)
-     *     .structureName('gametests:mediumglass');
+     *     test.succeedWhen(() => {
+     *       test.assertEntityPresentInArea(victimId, false);
+     *     });
+     *   })
+     *   .maxTicks(400)
+     *   .structureName('gametests:mediumglass');
      * ```
      * @example simpleMobGameTest.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function simpleMobGameTest(test: Test) {
      *   const attackerId = MinecraftEntityTypes.Fox;
@@ -1503,7 +1511,7 @@ export class Test {
      *     test.assertEntityPresentInArea(victimId, false);
      *   });
      * }
-     * register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");
+     * register('StarterTests', 'simpleMobTest', simpleMobGameTest).maxTicks(400).structureName('gametests:mediumglass');
      * ```
      */
     assertEntityPresentInArea(entityTypeIdentifier: string, isPresent?: boolean): void;
@@ -2055,9 +2063,9 @@ export class Test {
      * {@link GameTestError}
      * @example minibiomes.ts
      * ```typescript
-     * import { EntityComponentTypes } from "@minecraft/server";
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftBlockTypes, MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { EntityComponentTypes } from '@minecraft/server';
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftBlockTypes, MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function minibiomes(test: Test) {
      *   const minecart = test.spawn(MinecraftEntityTypes.Minecart, { x: 9, y: 7, z: 7 });
@@ -2071,7 +2079,7 @@ export class Test {
      *
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
      * }
-     * register("ChallengeTests", "minibiomes", minibiomes).structureName("gametests:minibiomes").maxTicks(160);
+     * register('ChallengeTests', 'minibiomes', minibiomes).structureName('gametests:minibiomes').maxTicks(160);
      * ```
      */
     setBlockType(blockType: minecraftserver.BlockType | string, blockLocation: minecraftserver.Vector3): void;
@@ -2135,26 +2143,26 @@ export class Test {
      * import * as gameTest from '@minecraft/server-gametest';
      *
      * gameTest
-     *     .register('StarterTests', 'simpleMobTest', (test: gameTest.Test) => {
-     *         const attackerId = 'fox';
-     *         const victimId = 'chicken';
+     *   .register('StarterTests', 'simpleMobTest', (test: gameTest.Test) => {
+     *     const attackerId = 'fox';
+     *     const victimId = 'chicken';
      *
-     *         test.spawn(attackerId, { x: 5, y: 2, z: 5 });
-     *         test.spawn(victimId, { x: 2, y: 2, z: 2 });
+     *     test.spawn(attackerId, { x: 5, y: 2, z: 5 });
+     *     test.spawn(victimId, { x: 2, y: 2, z: 2 });
      *
-     *         test.assertEntityPresentInArea(victimId, true);
+     *     test.assertEntityPresentInArea(victimId, true);
      *
-     *         test.succeedWhen(() => {
-     *             test.assertEntityPresentInArea(victimId, false);
-     *         });
-     *     })
-     *     .maxTicks(400)
-     *     .structureName('gametests:mediumglass');
+     *     test.succeedWhen(() => {
+     *       test.assertEntityPresentInArea(victimId, false);
+     *     });
+     *   })
+     *   .maxTicks(400)
+     *   .structureName('gametests:mediumglass');
      * ```
      * @example simpleMobGameTest.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function simpleMobGameTest(test: Test) {
      *   const attackerId = MinecraftEntityTypes.Fox;
@@ -2169,12 +2177,12 @@ export class Test {
      *     test.assertEntityPresentInArea(victimId, false);
      *   });
      * }
-     * register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");
+     * register('StarterTests', 'simpleMobTest', simpleMobGameTest).maxTicks(400).structureName('gametests:mediumglass');
      * ```
      * @example phantomsShouldFlyFromCats.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function phantomsShouldFlyFromCats(test: Test) {
      *   test.spawn(MinecraftEntityTypes.Cat, { x: 4, y: 3, z: 3 });
@@ -2183,14 +2191,15 @@ export class Test {
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Phantom, { x: 4, y: 6, z: 3 }, true);
      * }
      *
-     * register("MobBehaviorTests", "phantoms_should_fly_from_cats", phantomsShouldFlyFromCats)
-     *   .structureName("gametests:glass_cells");
+     * register('MobBehaviorTests', 'phantoms_should_fly_from_cats', phantomsShouldFlyFromCats).structureName(
+     *   'gametests:glass_cells'
+     * );
      * ```
      * @example minibiomes.ts
      * ```typescript
-     * import { EntityComponentTypes } from "@minecraft/server";
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftBlockTypes, MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { EntityComponentTypes } from '@minecraft/server';
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftBlockTypes, MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function minibiomes(test: Test) {
      *   const minecart = test.spawn(MinecraftEntityTypes.Minecart, { x: 9, y: 7, z: 7 });
@@ -2204,7 +2213,7 @@ export class Test {
      *
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
      * }
-     * register("ChallengeTests", "minibiomes", minibiomes).structureName("gametests:minibiomes").maxTicks(160);
+     * register('ChallengeTests', 'minibiomes', minibiomes).structureName('gametests:minibiomes').maxTicks(160);
      * ```
      */
     spawn(entityTypeIdentifier: string, blockLocation: minecraftserver.Vector3): minecraftserver.Entity;
@@ -2414,8 +2423,8 @@ export class Test {
      * @throws This function can throw errors.
      * @example simpleMobGameTest.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function simpleMobGameTest(test: Test) {
      *   const attackerId = MinecraftEntityTypes.Fox;
@@ -2430,7 +2439,7 @@ export class Test {
      *     test.assertEntityPresentInArea(victimId, false);
      *   });
      * }
-     * register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");
+     * register('StarterTests', 'simpleMobTest', simpleMobGameTest).maxTicks(400).structureName('gametests:mediumglass');
      * ```
      */
     succeedWhen(callback: () => void): void;
@@ -2514,8 +2523,8 @@ export class Test {
      * @throws This function can throw errors.
      * @example phantomsShouldFlyFromCats.ts
      * ```typescript
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function phantomsShouldFlyFromCats(test: Test) {
      *   test.spawn(MinecraftEntityTypes.Cat, { x: 4, y: 3, z: 3 });
@@ -2524,14 +2533,15 @@ export class Test {
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Phantom, { x: 4, y: 6, z: 3 }, true);
      * }
      *
-     * register("MobBehaviorTests", "phantoms_should_fly_from_cats", phantomsShouldFlyFromCats)
-     *   .structureName("gametests:glass_cells");
+     * register('MobBehaviorTests', 'phantoms_should_fly_from_cats', phantomsShouldFlyFromCats).structureName(
+     *   'gametests:glass_cells'
+     * );
      * ```
      * @example minibiomes.ts
      * ```typescript
-     * import { EntityComponentTypes } from "@minecraft/server";
-     * import { Test, register } from "@minecraft/server-gametest";
-     * import { MinecraftBlockTypes, MinecraftEntityTypes } from "@minecraft/vanilla-data";
+     * import { EntityComponentTypes } from '@minecraft/server';
+     * import { Test, register } from '@minecraft/server-gametest';
+     * import { MinecraftBlockTypes, MinecraftEntityTypes } from '@minecraft/vanilla-data';
      *
      * function minibiomes(test: Test) {
      *   const minecart = test.spawn(MinecraftEntityTypes.Minecart, { x: 9, y: 7, z: 7 });
@@ -2545,7 +2555,7 @@ export class Test {
      *
      *   test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
      * }
-     * register("ChallengeTests", "minibiomes", minibiomes).structureName("gametests:minibiomes").maxTicks(160);
+     * register('ChallengeTests', 'minibiomes', minibiomes).structureName('gametests:minibiomes').maxTicks(160);
      * ```
      */
     succeedWhenEntityPresent(
@@ -2713,7 +2723,7 @@ export class GameTestCompletedError extends Error {
      * This property can be read in early-execution mode.
      *
      */
-    reason: GameTestCompletedErrorReason;
+    readonly reason: GameTestCompletedErrorReason;
 }
 
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -2724,19 +2734,19 @@ export class GameTestError extends Error {
      * This property can be read in early-execution mode.
      *
      */
-    context?: GameTestErrorContext;
+    readonly context?: GameTestErrorContext;
     /**
      * @remarks
      * This property can be read in early-execution mode.
      *
      */
-    messageParameters: string[];
+    readonly messageParameters: string[];
     /**
      * @remarks
      * This property can be read in early-execution mode.
      *
      */
-    type: GameTestErrorType;
+    readonly type: GameTestErrorType;
 }
 
 /**
@@ -2776,8 +2786,8 @@ export function getPlayerSkin(player: minecraftserver.Player): PlayerSkinData;
  * builder methods.
  * @example simpleMobGameTest.ts
  * ```typescript
- * import { Test, register } from "@minecraft/server-gametest";
- * import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
+ * import { Test, register } from '@minecraft/server-gametest';
+ * import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
  *
  * function simpleMobGameTest(test: Test) {
  *   const attackerId = MinecraftEntityTypes.Fox;
@@ -2792,7 +2802,7 @@ export function getPlayerSkin(player: minecraftserver.Player): PlayerSkinData;
  *     test.assertEntityPresentInArea(victimId, false);
  *   });
  * }
- * register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");
+ * register('StarterTests', 'simpleMobTest', simpleMobGameTest).maxTicks(400).structureName('gametests:mediumglass');
  * ```
  */
 export function register(
@@ -2825,21 +2835,21 @@ export function register(
  * import * as gameTest from '@minecraft/server-gametest';
  *
  * gameTest
- *     .registerAsync('StarterTests', 'simpleMobTest', async (test: gameTest.Test) => {
- *         const attackerId = 'fox';
- *         const victimId = 'chicken';
+ *   .registerAsync('StarterTests', 'simpleMobTest', async (test: gameTest.Test) => {
+ *     const attackerId = 'fox';
+ *     const victimId = 'chicken';
  *
- *         test.spawn(attackerId, { x: 5, y: 2, z: 5 });
- *         test.spawn(victimId, { x: 2, y: 2, z: 2 });
+ *     test.spawn(attackerId, { x: 5, y: 2, z: 5 });
+ *     test.spawn(victimId, { x: 2, y: 2, z: 2 });
  *
- *         test.assertEntityPresentInArea(victimId, true);
+ *     test.assertEntityPresentInArea(victimId, true);
  *
- *         test.succeedWhen(() => {
- *             test.assertEntityPresentInArea(victimId, false);
- *         });
- *     })
- *     .maxTicks(400)
- *     .structureName('gametests:mediumglass');
+ *     test.succeedWhen(() => {
+ *       test.assertEntityPresentInArea(victimId, false);
+ *     });
+ *   })
+ *   .maxTicks(400)
+ *   .structureName('gametests:mediumglass');
  * ```
  */
 export function registerAsync(

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/server-gametest",
-  "version": "1.0.0-beta.1.26.2-stable",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "peerDependencies": {
-    "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.6.0-beta.1.26.2-stable"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server-gametest",
+  "version": "1.0.0-beta.1.26.20-preview.22",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.0.0",
+    "@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.8.0-beta.1.26.20-preview.22"
+  },
+  "license": "MIT"
 }