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

package/index.d.ts

@@ -17,7 +17,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-gametest",
- *   "version": "1.0.0-internal.1.20.30-preview.24"
+ *   "version": "1.0.0-internal.1.20.30-stable"
  * }
  * ```
  *
@@ -386,7 +386,10 @@ export class SculkSpreader {
  * how a player moves throughout the world and to support
  * testing of how entities and the environment will react to a
  * player. This type derives much of its structure and methods
- * from the {@link @minecraft/server.Player} type.
+ * from the {@link @minecraft/server.Player} type. Note that
+ * many types of events that may be available for entities more
+ * broadly, such as item use events, may not fire in the same
+ * capacity for simulated players.
  */
 // @ts-ignore Class inheritance allowed for native defined classes
 export class SimulatedPlayer extends minecraftserver.Player {
@@ -919,6 +922,8 @@ export class Test {
      * Message that is passed if the _condition_ does not evaluate
      * to true.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assert(condition: boolean, message: string): void;
     /**
@@ -935,6 +940,8 @@ export class Test {
      * specified type is at the location. If false, tests that a
      * block of the specified type is not present.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertBlockPresent(
         blockType: minecraftserver.BlockType | string,
@@ -953,6 +960,8 @@ export class Test {
      * Callback function that contains additional tests based on
      * the block at the specified location.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example testIfButtonNotPressed.js
      * ```typescript
      * test.assertBlockState(buttonPos, (block) => {
@@ -977,6 +986,8 @@ export class Test {
      * false, tests whether the mob is not able to reach the
      * location.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertCanReachLocation(
         mob: minecraftserver.Entity,
@@ -997,6 +1008,8 @@ export class Test {
      * Location of the block with a container (for example, a
      * chest) to test the contents of.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertContainerContains(itemStack: minecraftserver.ItemStack, blockLocation: minecraftserver.Vector3): void;
     /**
@@ -1008,6 +1021,8 @@ export class Test {
      * Location of the block with a container (for example, a
      * chest) to test is empty of contents.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertContainerEmpty(blockLocation: minecraftserver.Vector3): void;
     /**
@@ -1030,6 +1045,8 @@ export class Test {
      * Whether or not the entity is expected to have the specified
      * armor equipped.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example horseArmorTest.js
      * ```typescript
      * test.assertEntityHasArmor("minecraft:horse", armorSlotTorso, "diamond_horse_armor", 0, horseLocation, true);
@@ -1062,6 +1079,8 @@ export class Test {
      * Determines whether to test that the component exists, or
      * does not.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example sheepShearedTest.js
      * ```typescript
      * test.assertEntityHasComponent("minecraft:sheep", "minecraft:is_sheared", entityLoc, false);
@@ -1088,6 +1107,8 @@ export class Test {
      * Whether to test that an entity is present or not present at
      * the specified location.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertEntityInstancePresent(
         entity: minecraftserver.Entity,
@@ -1106,6 +1127,8 @@ export class Test {
      * present in the GameTest area. If false, tests that the
      * specified entity is not present.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example simpleMobTest.ts
      * ```typescript
      * gt.register("StarterTests", "simpleMobTest", (test: gt.Test) => {
@@ -1148,6 +1171,8 @@ export class Test {
      * specified type is present. If false, tests that an entity of
      * the specified type is not present.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertEntityPresent(
         entityTypeIdentifier: string,
@@ -1169,6 +1194,8 @@ export class Test {
      * specified type is present in the GameTest area. If false,
      * tests that an entity of the specified type is not present.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example simpleMobTest.ts
      * ```typescript
      *   gt.register("StarterTests", "simpleMobTest", (test: gt.Test) => {
@@ -1207,6 +1234,8 @@ export class Test {
      * entity with the specified identifier is found, an exception
      * is thrown.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example villagerEffectTest.js
      * ```typescript
      * test.assertEntityState(
@@ -1238,6 +1267,8 @@ export class Test {
      * the specified location. If false, tests that an entity is
      * not testing the specified location.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertEntityTouching(entityTypeIdentifier: string, location: minecraftserver.Vector3, isTouching?: boolean): void;
     /**
@@ -1253,6 +1284,8 @@ export class Test {
      * Whether to test that the block at _position_ is expected to
      * be waterlogged.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertIsWaterlogged(blockLocation: minecraftserver.Vector3, isWaterlogged?: boolean): void;
     /**
@@ -1270,6 +1303,8 @@ export class Test {
      * @param count
      * Number of items, at minimum, to look and test for.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example findFeathers.js
      * ```typescript
      * test.assertItemEntityCountIs(Items.feather, expectedFeatherLoc, 0, 1);
@@ -1299,6 +1334,8 @@ export class Test {
      * specified type is present. If false, tests that an item
      * entity of the specified type is not present.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertItemEntityPresent(
         itemType: minecraftserver.ItemType | string,
@@ -1316,6 +1353,8 @@ export class Test {
      * @param power
      * Expected power level.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     assertRedstonePower(blockLocation: minecraftserver.Vector3, power: number): void;
     /**
@@ -1329,6 +1368,8 @@ export class Test {
      * @param dropResources
      * Whether to add resources exposed with a particular drop.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     destroyBlock(blockLocation: minecraftserver.Vector3, dropResources?: boolean): void;
     /**
@@ -1361,6 +1402,8 @@ export class Test {
      * @param blockLocation
      * Location of the block to retrieve.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     getBlock(blockLocation: minecraftserver.Vector3): minecraftserver.Block;
     /**
@@ -1368,6 +1411,8 @@ export class Test {
      * Gets the dimension of this test.
      *
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     getDimension(): minecraftserver.Dimension;
     /**
@@ -1381,6 +1426,8 @@ export class Test {
      * @param blockLocation
      * Location of the block to retrieve.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     getFenceConnectivity(blockLocation: minecraftserver.Vector3): FenceConnectivity;
     /**
@@ -1392,7 +1439,12 @@ export class Test {
      *
      * @param blockLocation
      * Location of the block to retrieve a sculk spreader from.
+     * @returns
+     * Returns the SculkSpreader or undefined if no SculkSpreader
+     * is present on the block.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     getSculkSpreader(blockLocation: minecraftserver.Vector3): SculkSpreader;
     /**
@@ -1421,6 +1473,8 @@ export class Test {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     killAllEntities(): void;
     /**
@@ -1428,6 +1482,8 @@ export class Test {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     onPlayerJump(mob: minecraftserver.Entity, jumpAmount: number): void;
     /**
@@ -1441,6 +1497,8 @@ export class Test {
      * @throws
      * Will throw an error if a button is not present at the
      * specified position.
+     *
+     * {@link GameTestError}
      */
     pressButton(blockLocation: minecraftserver.Vector3): void;
     /**
@@ -1452,6 +1510,8 @@ export class Test {
      * @param text
      * Message to display.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     print(text: string): void;
     /**
@@ -1465,6 +1525,8 @@ export class Test {
      * @throws
      * Will throw an error if a lever is not present at the
      * specified position.
+     *
+     * {@link GameTestError}
      */
     pullLever(blockLocation: minecraftserver.Vector3): void;
     /**
@@ -1479,6 +1541,8 @@ export class Test {
      * @param duration
      * Number of ticks to pulse Redstone.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     pulseRedstone(blockLocation: minecraftserver.Vector3, duration: number): void;
     /**
@@ -1495,6 +1559,8 @@ export class Test {
      * @returns
      * A location relative to the GameTest command block.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     relativeBlockLocation(worldBlockLocation: minecraftserver.Vector3): minecraftserver.Vector3;
     /**
@@ -1513,6 +1579,8 @@ export class Test {
      * @returns
      * A location relative to the GameTest command block.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     relativeLocation(worldLocation: minecraftserver.Vector3): minecraftserver.Vector3;
     /**
@@ -1540,6 +1608,8 @@ export class Test {
      * test direction; Passing in Direction.north will return the
      * opposite of the test direction, and so on.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     rotateDirection(direction: minecraftserver.Direction): minecraftserver.Direction;
     /**
@@ -1547,6 +1617,8 @@ export class Test {
      * This function can't be called in read-only mode.
      *
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     rotateVector(vector: minecraftserver.Vector3): minecraftserver.Vector3;
     /**
@@ -1591,6 +1663,8 @@ export class Test {
      * @param blockLocation
      * Location of the block to set.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     setBlockPermutation(blockData: minecraftserver.BlockPermutation, blockLocation: minecraftserver.Vector3): void;
     /**
@@ -1605,6 +1679,8 @@ export class Test {
      * @param blockLocation
      * Location of the block to set.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     setBlockType(blockType: minecraftserver.BlockType | string, blockLocation: minecraftserver.Vector3): void;
     /**
@@ -1620,6 +1696,8 @@ export class Test {
      * Type of fluid to set. See {@link
      * @minecraft/server-gametest.FluidType} for a list of values.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     setFluidContainer(location: minecraftserver.Vector3, type: minecraftserver.FluidType): void;
     /**
@@ -1633,6 +1711,8 @@ export class Test {
      * @param fuseLength
      * Length of time, in ticks, before the entity explodes.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     setTntFuse(entity: minecraftserver.Entity, fuseLength: number): void;
     /**
@@ -1650,6 +1730,8 @@ export class Test {
      * The spawned entity. If the entity cannot be spawned, returns
      * undefined.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      * @example simpleMobTest.ts
      * ```typescript
      *   gt.register("StarterTests", "simpleMobTest", (test: gt.Test) => {
@@ -1690,6 +1772,8 @@ export class Test {
      * The spawned entity. If the entity cannot be spawned, returns
      * undefined.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      * @example spawnAdultPig.js
      * ```typescript
      * test.spawn("minecraft:pig<minecraft:ageable_grow_up>", { x: 1.5, y: 2, z: 1.5 });
@@ -1707,6 +1791,8 @@ export class Test {
      * @param location
      * Location to create the item entity at.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      * @example spawnEmeralds.js
      * ```typescript
      * const oneEmerald = new ItemStack(MinecraftItemTypes.Emerald, 1, 0);
@@ -1728,6 +1814,8 @@ export class Test {
      * @param name
      * Name to give the new simulated player.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     spawnSimulatedPlayer(
         blockLocation: minecraftserver.Vector3,
@@ -1745,6 +1833,8 @@ export class Test {
      * @param blockLocation
      * Location where the entity should be spawned.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     spawnWithoutBehaviors(entityTypeIdentifier: string, blockLocation: minecraftserver.Vector3): minecraftserver.Entity;
     /**
@@ -1758,6 +1848,8 @@ export class Test {
      * @param location
      * Location where the entity should be spawned.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     spawnWithoutBehaviorsAtLocation(
         entityTypeIdentifier: string,
@@ -1778,6 +1870,8 @@ export class Test {
      * Direction to spread. Use the Minecraft.Direction enum to
      * specify a direction.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      * @example spreadFromFaceTowardDirection.js
      * ```typescript
      * test.spreadFromFaceTowardDirection({ x: 1, y: 2, z: 1 }, Direction.south, Direction.down);
@@ -1903,6 +1997,8 @@ export class Test {
      * specified type is present. If false, tests that a block of
      * the specified type is not present.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     succeedWhenBlockPresent(
         blockType: minecraftserver.BlockType | string,
@@ -1976,6 +2072,8 @@ export class Test {
      * minecraft:grow_up, minecraft:grow_down and
      * minecraft:grow_sideways.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     triggerInternalBlockEvent(blockLocation: minecraftserver.Vector3, event: string, eventParameters?: number[]): void;
     /**
@@ -2007,6 +2105,8 @@ export class Test {
      * @param speedModifier
      * Adjustable modifier to the mob's walking speed.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     walkTo(mob: minecraftserver.Entity, blockLocation: minecraftserver.Vector3, speedModifier?: number): void;
     /**
@@ -2025,6 +2125,8 @@ export class Test {
      * @param speedModifier
      * Adjustable modifier to the mob's walking speed.
      * @throws This function can throw errors.
+     *
+     * {@link GameTestError}
      */
     walkToLocation(mob: minecraftserver.Entity, location: minecraftserver.Vector3, speedModifier?: number): void;
     /**
@@ -2039,6 +2141,8 @@ export class Test {
      * @returns
      * An absolute location relative to the GameTest command block.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     worldBlockLocation(relativeBlockLocation: minecraftserver.Vector3): minecraftserver.Vector3;
     /**
@@ -2053,6 +2157,8 @@ export class Test {
      * @returns
      * An absolute location relative to the GameTest command block.
      * @throws This function can throw errors.
+     *
+     * {@link minecraftserver.GameTestError}
      */
     worldLocation(relativeLocation: minecraftserver.Vector3): minecraftserver.Vector3;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-gametest",
-  "version": "1.0.0-beta.1.20.30-preview.24",
+  "version": "1.0.0-beta.1.20.30-stable",
   "description": "",
   "contributors": [
     {
@@ -13,7 +13,7 @@
     }
   ],
   "dependencies": {
-    "@minecraft/server": "^1.6.0-beta.1.20.30-preview.24"
+    "@minecraft/server": "^1.6.0-beta.1.20.30-stable"
   },
   "license": "MIT"
 }