@minecraft/server-gametest 1.0.0-beta.1.19.80-preview.23 → 1.0.0-beta.1.19.80-stable

package/index.d.ts

@@ -17,7 +17,7 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server-gametest",
- *   "version": "1.0.0-internal.1.19.80-preview.23"
+ *   "version": "1.0.0-internal.1.19.80-stable"
  * }
  * ```
  *
@@ -35,6 +35,7 @@ export enum GameTestErrorType {
     Unknown = 'Unknown',
     Waiting = 'Waiting',
 }
+
 /**
  * Returns information about whether this fence is connected to
  * other fences in several directions.
@@ -42,26 +43,35 @@ export enum GameTestErrorType {
 export class FenceConnectivity {
     protected constructor();
     /**
+     * @remarks
      * Represents whether this fence block is connected to another
      * fence to the east (x + 1).
+     *
      */
     readonly east: boolean;
     /**
+     * @remarks
      * Represents whether this fence block is connected to another
      * fence to the north (z - 1).
+     *
      */
     readonly north: boolean;
     /**
+     * @remarks
      * Represents whether this fence block is connected to another
      * fence to the south (z + 1).
+     *
      */
     readonly south: boolean;
     /**
+     * @remarks
      * Represents whether this fence block is connected to another
      * fence to the west (x - 1).
+     *
      */
     readonly west: boolean;
 }
+
 /**
  * Executes a set of steps defined via chained .thenXyz
  * methods, sequentially. This facilitates a 'script' of
@@ -74,6 +84,9 @@ export class GameTestSequence {
      * Runs the given callback as a step within a GameTest
      * sequence. Exceptions thrown within the callback will end
      * sequence execution.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Callback function to execute.
      * @returns
@@ -86,6 +99,9 @@ export class GameTestSequence {
      * After a delay, runs the given callback as a step within a
      * GameTest sequence. Exceptions thrown within the callback
      * will end sequence execution.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param delayTicks
      * Number of ticks to wait before executing the callback.
      * @param callback
@@ -99,6 +115,9 @@ export class GameTestSequence {
      * @remarks
      * Runs the given callback every tick for the given number of
      * ticks.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Callback function to execute.
      * @returns
@@ -110,6 +129,9 @@ export class GameTestSequence {
      * @remarks
      * Causes the test to fail if this step in the GameTest
      * sequence is reached.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param errorMessage
      * Error message summarizing the failure condition.
      */
@@ -117,6 +139,9 @@ export class GameTestSequence {
     /**
      * @remarks
      * Idles the GameTest sequence for the specified delayTicks.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param delayTicks
      * Number of ticks to delay for this step in the GameTest
      * sequence.
@@ -129,6 +154,9 @@ export class GameTestSequence {
      * @remarks
      * Marks the GameTest a success if this step is reached in the
      * GameTest sequence.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     thenSucceed(): void;
     /**
@@ -136,6 +164,9 @@ export class GameTestSequence {
      * Executes the given callback every tick until it succeeds.
      * Exceptions thrown within the callback will end sequence
      * execution.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Testing callback function to execute. Typically, this
      * function will have .assertXyz functions within it.
@@ -149,6 +180,9 @@ export class GameTestSequence {
      * After a delay from the previous step, executes the given
      * callback every tick until it succeeds. Exceptions thrown
      * within the callback will end sequence execution.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param delayTicks
      * Tick (after the previous step in the GameTest sequence) to
      * run the callback at.
@@ -161,6 +195,7 @@ export class GameTestSequence {
      */
     thenWaitAfter(delayTicks: number, callback: () => void): GameTestSequence;
 }
+
 /**
  * A utility class to set GameTest parameters for a test.
  * Methods can be chained together to set multiple properties.
@@ -170,6 +205,9 @@ export class RegistrationBuilder {
     /**
      * @remarks
      * Sets the batch for the test to run in.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param batchName
      * Name of the batch for the test.
      * @returns
@@ -181,6 +219,9 @@ export class RegistrationBuilder {
      * @remarks
      * Sets the maximum number of times a test will try to rerun if
      * it fails.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * RegistrationBuilder object where additional configuration
      * methods can be called.
@@ -190,6 +231,9 @@ export class RegistrationBuilder {
      * @remarks
      * Sets the maximum number of ticks a test will run for before
      * timing out and failing.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * RegistrationBuilder object where additional configuration
      * methods can be called.
@@ -199,6 +243,9 @@ export class RegistrationBuilder {
      * @remarks
      * Size around the GameTest, in blocks, that should be reserved
      * for the test when running multiple tests together.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param paddingBlocks
      * Size, in blocks, around the GameTest where additional
      * GameTests should not be created.
@@ -211,6 +258,9 @@ export class RegistrationBuilder {
      * @remarks
      * Whether this test is required to pass as part of its broader
      * set of tests.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param isRequired
      * If set to true, the test must pass in order for the entire
      * run of tests to pass.
@@ -223,6 +273,9 @@ export class RegistrationBuilder {
      * @remarks
      * Sets the number of successful test runs to be considered
      * successful.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * RegistrationBuilder object where additional configuration
      * methods can be called.
@@ -232,12 +285,18 @@ export class RegistrationBuilder {
      * @remarks
      * If true, runs the test in all four rotations when run via
      * /gametest runset.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     rotateTest(rotate: boolean): RegistrationBuilder;
     /**
      * @remarks
      * Sets the number of ticks for a test to wait before executing
      * when the structure is spawned.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * RegistrationBuilder object where additional configuration
      * methods can be called.
@@ -248,6 +307,9 @@ export class RegistrationBuilder {
      * Sets the name of the structure for a test to use. "xyz:bar"
      * will load `/structures/xyz/bar.mcstructure` from the
      * behavior pack stack.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * RegistrationBuilder object where additional configuration
      * methods can be called.
@@ -257,12 +319,16 @@ export class RegistrationBuilder {
      * @remarks
      * Adds a tag to a test. You can run all tests with a given tag
      * with `/gametest runset <tag>`.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * RegistrationBuilder object where additional configuration
      * methods can be called.
      */
     tag(tag: string): RegistrationBuilder;
 }
+
 /**
  * Implements a class that can be used for testing sculk
  * spreading behaviors. This sculk spreader class can drive the
@@ -271,7 +337,9 @@ export class RegistrationBuilder {
 export class SculkSpreader {
     protected constructor();
     /**
+     * @remarks
      * Gets the maximum charge of a sculk spreader.
+     *
      * @throws This property can throw when used.
      */
     readonly maxCharge: number;
@@ -279,27 +347,40 @@ export class SculkSpreader {
      * @remarks
      * Adds a cursor - which is a notional waypoint that the sculk
      * will spread in the direction of.
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     addCursorsWithOffset(offset: minecraftserver.Vector3, charge: number): void;
     /**
      * @remarks
      * Retrieves the current position of the specified cursor.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getCursorPosition(index: number): minecraftserver.Vector3;
     /**
      * @remarks
      * Returns a number of overall cursors for this sculk spreader.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getNumberOfCursors(): number;
     /**
      * @remarks
      * Gets the total current charge of the sculk spreader.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getTotalCharge(): number;
 }
+
 /**
  * A simulated player can be used within GameTests to represent
  * how a player moves throughout the world and to support
@@ -310,10 +391,17 @@ export class SculkSpreader {
 export class SimulatedPlayer extends minecraftserver.Player {
     protected constructor();
     /**
+     * @remarks
      * Rotation of the head across pitch and yaw angles.
+     *
      * @throws This property can throw when used.
      */
     readonly headRotation: minecraftserver.XYRotation;
+    /**
+     * @remarks
+     * This property can't be edited in read-only mode.
+     *
+     */
     isSprinting: boolean;
     /**
      * @remarks
@@ -321,6 +409,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Returns true if the attack was performed - for example, the
      * player was not on cooldown and had a valid target. Target
      * selection is performed by raycasting from the player's head.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     attack(): boolean;
@@ -331,6 +422,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * player was not on cooldown and had a valid target. The
      * attack can be performed at any distance and does not require
      * line of sight to the target entity.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     attackEntity(entity: minecraftserver.Entity): boolean;
@@ -340,6 +434,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * the server player's game mode. The block will be hit until
      * broken, an item is used or stopBreakingBlock is called.
      * Returns true if the block at blockLocation is solid.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to interact with.
      * @param direction
@@ -351,12 +448,18 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Simulates and performs a disconnection of the simulated
      * player from the world.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     disconnect(): void;
     /**
      * @remarks
      * Gives the simulated player a particular item stack.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemStack
      * Item to give.
      * @param selectSlot
@@ -369,6 +472,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Performs a raycast from the player’s head and interacts with
      * the first intersected block or entity. Returns true if the
      * interaction was successful. Maximum range is 6 blocks.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     interact(): boolean;
@@ -377,6 +483,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Causes the simulated player to interact with a block. The
      * block at the specified block location must be solid. Returns
      * true if the interaction was performed.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to interact with.
      * @param direction
@@ -388,6 +497,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Causes the simulated player to interact with a mob. Returns
      * true if the interaction was performed.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entity
      * Entity to interact with.
      * @throws This function can throw errors.
@@ -396,6 +508,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
     /**
      * @remarks
      * Causes the simulated player to jump.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * True if a jump was performed.
      * @throws This function can throw errors.
@@ -405,6 +520,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Rotates the simulated player's head/body to look at the
      * given block location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     lookAtBlock(blockLocation: minecraftserver.Vector3): void;
@@ -412,6 +530,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Rotates the simulated player's head/body to look at the
      * given entity.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     lookAtEntity(entity: minecraftserver.Entity): void;
@@ -419,6 +540,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Rotates the simulated player's head/body to look at the
      * given location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     lookAtLocation(location: minecraftserver.Vector3): void;
@@ -426,6 +550,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Orders the simulated player to walk in the given direction
      * relative to the GameTest.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     move(westEast: number, northSouth: number, speed?: number): void;
@@ -433,6 +560,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Orders the simulated player to walk in the given direction
      * relative to the player's current rotation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     moveRelative(leftRight: number, backwardForward: number, speed?: number): void;
@@ -442,6 +572,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * location in a straight line. If a move or navigation is
      * already playing, this will override the last
      * move/navigation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     moveToBlock(blockLocation: minecraftserver.Vector3, speed?: number): void;
@@ -450,6 +583,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Orders the simulated player to move to the given location in
      * a straight line. If a move or navigation is already playing,
      * this will override the last move/navigation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     moveToLocation(location: minecraftserver.Vector3, speed?: number): void;
@@ -461,6 +597,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * that if the simulated player gets stuck, that simulated
      * player will stop. The player must be touching the ground in
      * order to start navigation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     navigateToBlock(blockLocation: minecraftserver.Vector3, speed?: number): minecraftserver.NavigationResult;
@@ -469,6 +608,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Will use navigation to follow the selected entity to within
      * a one block radius. If a move or navigation is already
      * playing, this will override the last move/navigation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     navigateToEntity(entity: minecraftserver.Entity, speed?: number): minecraftserver.NavigationResult;
@@ -480,6 +622,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * the simulated player gets stuck, that simulated player will
      * stop. The player must be touching the ground in order to
      * start navigation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     navigateToLocation(location: minecraftserver.Vector3, speed?: number): minecraftserver.NavigationResult;
@@ -488,6 +633,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Use navigation to follow the route provided via the
      * locations parameter. If a move or navigation is already
      * playing, this will override the last move/navigation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param locations
      * A list of locations to use for routing.
      * @param speed
@@ -498,6 +646,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
     /**
      * @remarks
      * Respawns the particular simulated player.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     respawn(): boolean;
@@ -505,6 +656,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Causes the simulated player to turn by the provided angle,
      * relative to the player's current rotation.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     rotateBody(angleInDegrees: number): void;
@@ -512,6 +666,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Causes the simulated player to turn to face the provided
      * angle, relative to the GameTest.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     setBodyRotation(angleInDegrees: number): void;
@@ -519,6 +676,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Sets the game mode that the simulated player is operating
      * under.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param gameMode
      * Game mode to set.
      * @throws This function can throw errors.
@@ -527,6 +687,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
     /**
      * @remarks
      * Sets a particular item for the simulated player.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemStack
      * Item to set.
      * @param slot
@@ -539,12 +702,18 @@ export class SimulatedPlayer extends minecraftserver.Player {
     /**
      * @remarks
      * Stops destroying the block that is currently being hit.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     stopBreakingBlock(): void;
     /**
      * @remarks
      * Stops interacting with entities or blocks.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     stopInteracting(): void;
@@ -552,12 +721,18 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Stops moving/walking/following if the simulated player is
      * moving.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     stopMoving(): void;
     /**
      * @remarks
      * Stops using the currently active item.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     stopUsingItem(): void;
@@ -565,6 +740,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Causes the simulated player to use an item. Does not consume
      * the item. Returns false if the item is on cooldown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemStack
      * Item to use.
      * @throws This function can throw errors.
@@ -574,6 +752,9 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * @remarks
      * Causes the simulated player to hold and use an item in their
      * inventory.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param slot
      * Index of the inventory slot.
      * @throws This function can throw errors.
@@ -584,16 +765,15 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Causes the simulated player to use an item in their
      * inventory on a block. The block at the specified block
      * location must be solid. Returns true if the item was used.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param slot
      * Index of the slot to use.
      * @param blockLocation
      * Location to use the item upon.
      * @param direction
      * Direction to place the specified item within.
-     * @param faceLocationX
-     * Block-face-relative X position where to place the item.
-     * @param faceLocationY
-     * Block-face-relative Y position where to place the item.
      * @throws This function can throw errors.
      */
     useItemInSlotOnBlock(
@@ -608,16 +788,15 @@ export class SimulatedPlayer extends minecraftserver.Player {
      * Causes the simulated player to use an item on a block. The
      * block at the specified block location must be solid. Returns
      * true if the item was used.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemStack
      * Item to use.
      * @param blockLocation
      * Location to use the item upon.
      * @param direction
      * Direction to place the specified item within.
-     * @param faceLocationX
-     * Block-face-relative X position where to place the item.
-     * @param faceLocationY
-     * Block-face-relative Y position where to place the item.
      * @throws This function can throw errors.
      */
     useItemOnBlock(
@@ -628,6 +807,7 @@ export class SimulatedPlayer extends minecraftserver.Player {
         faceLocationY?: number,
     ): boolean;
 }
+
 /**
  * These well-known tags can be used to classify different
  * tests into suites to run.
@@ -635,26 +815,35 @@ export class SimulatedPlayer extends minecraftserver.Player {
 export class Tags {
     protected constructor();
     /**
+     * @remarks
      * Indicates that the tagged test should be a part of all
      * suites.
+     *
      */
     static readonly suiteAll = 'suite:all';
     /**
+     * @remarks
      * Indicates that the tagged test should be a part of an
      * internal (debug) test suite.
+     *
      */
     static readonly suiteDebug = 'suite:debug';
     /**
+     * @remarks
      * Indicates that the tagged test should be a part of the
      * default test suite.
+     *
      */
     static readonly suiteDefault = 'suite:default';
     /**
+     * @remarks
      * Indicates that the tagged test should be a part of a suite
      * of disabled tests.
+     *
      */
     static readonly suiteDisabled = 'suite:disabled';
 }
+
 /**
  * Main class for GameTest functions, with helpers and data for
  * manipulating the respective test. Note that all methods of
@@ -667,6 +856,9 @@ export class Test {
      * @remarks
      * Tests that the condition specified in _condition_ is true.
      * If not, an error with the specified _message_ is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param condition
      * Expression of the condition to evaluate.
      * @param message
@@ -679,6 +871,9 @@ export class Test {
      * @remarks
      * Tests that a block of the specified type is present at the
      * specified location. If it is not, an exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockType
      * Expected block type.
      * @param blockLocation
@@ -699,6 +894,9 @@ export class Test {
      * Tests that a block has a particular state value at the
      * specified location. If it does not have that state value, an
      * exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to test at.
      * @param callback
@@ -719,6 +917,9 @@ export class Test {
      * Tests that an entity can reach a particular location.
      * Depending on the value of canReach, throws an exception if
      * the condition is not met.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param mob
      * Entity that you wish to test the location against.
      * @param blockLocation
@@ -740,6 +941,9 @@ export class Test {
      * Tests that a container (e.g., a chest) at the specified
      * location contains a specified of item stack. If not, an
      * error is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemStack
      * Represents the type of item to check for. The specified
      * container must contain at least 1 item matching the item
@@ -754,6 +958,9 @@ export class Test {
      * @remarks
      * Tests that a container (e.g., a chest) at the specified
      * location is empty. If not, an error is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block with a container (for example, a
      * chest) to test is empty of contents.
@@ -764,6 +971,9 @@ export class Test {
      * @remarks
      * Tests that an entity has a specific piece of armor equipped.
      * If not, an error is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Identifier of the entity to match (e.g.,
      * 'minecraft:skeleton').
@@ -797,6 +1007,9 @@ export class Test {
      * @remarks
      * Tests that an entity has a particular component. If not, an
      * exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Identifier of the specified entity (e.g.,
      * 'minecraft:skeleton'). If the namespace is not specified,
@@ -829,6 +1042,9 @@ export class Test {
      * particular entity is present or not present at the specified
      * location. Depending on the value of isPresent, if the entity
      * is found or not found, an error is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entity
      * Specific entity to test for.
      * @param blockLocation
@@ -847,6 +1063,9 @@ export class Test {
      * @remarks
      * Tests that an entity instance is present within the GameTest
      * area. If not, an exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entity
      * Entity instance to test for.
      * @param isPresent
@@ -882,6 +1101,9 @@ export class Test {
      * or non-presence of entity of a specified type at a
      * particular location. If the condition is not met, an
      * exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to test for (e.g., 'minecraft:skeleton'). If
      * an entity namespace is not specified, 'minecraft:' is
@@ -907,6 +1129,9 @@ export class Test {
      * @remarks
      * Tests that an entity of a specified type is present within
      * the GameTest area. If not, an exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to test for (e.g., 'minecraft:skeleton'). If
      * an entity namespace is not specified, 'minecraft:' is
@@ -943,6 +1168,9 @@ export class Test {
      * Tests that an entity (e.g., a skeleton) at the specified
      * location has a particular piece of data. If not, an error is
      * thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the entity to look for.
      * @param entityTypeIdentifier
@@ -975,6 +1203,9 @@ export class Test {
      * Depending on the value of isTouching, tests that an entity
      * of a specified type is touching or connected to another
      * entity. If the condition is not met, an exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to test for (e.g., 'minecraft:skeleton'). If
      * an entity namespace is not specified, 'minecraft:' is
@@ -994,6 +1225,9 @@ export class Test {
      * at a location contains water. If the condition is not met,
      * an error is thrown. Pure water blocks are not considered to
      * be waterlogged.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to test for.
      * @param isWaterlogged
@@ -1006,6 +1240,9 @@ export class Test {
      * @remarks
      * Tests that items of a particular type and count are present
      * within an area. If not, an error is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemType
      * Type of item to look for.
      * @param blockLocation
@@ -1034,6 +1271,9 @@ export class Test {
      * particular item entity is present or not at a particular
      * location. If the condition is not met, an exception is
      * thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemType
      * Type of item to test for.
      * @param blockLocation
@@ -1056,6 +1296,9 @@ export class Test {
      * @remarks
      * Tests that Redstone power at a particular location matches a
      * particular value. If not, an exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location to test.
      * @param power
@@ -1066,6 +1309,9 @@ export class Test {
     /**
      * @remarks
      * Destroys a block at a particular location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to destroy.
      * @param dropResources
@@ -1076,6 +1322,9 @@ export class Test {
     /**
      * @remarks
      * Marks the current test as a failure case.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param errorMessage
      * Error message summarizing the failure condition.
      * @throws This function can throw errors.
@@ -1085,6 +1334,9 @@ export class Test {
      * @remarks
      * Runs the given callback. If the callback does not throw an
      * exception, the test is marked as a failure.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Callback function that runs. If the function runs
      * successfully, the test is marked as a failure. Typically,
@@ -1095,6 +1347,9 @@ export class Test {
     /**
      * @remarks
      * Gets a block at the specified block location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to retrieve.
      * @throws This function can throw errors.
@@ -1103,6 +1358,9 @@ export class Test {
     /**
      * @remarks
      * Gets the dimension of this test.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     getDimension(): minecraftserver.Dimension;
@@ -1111,6 +1369,9 @@ export class Test {
      * If the block at the specified block location is a fence,
      * this returns a helper object with details on how a fence is
      * connected.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to retrieve.
      * @throws This function can throw errors.
@@ -1120,6 +1381,9 @@ export class Test {
      * @remarks
      * Retrieves a sculk spreader object that can be used to
      * control and manage how sculk grows from a block.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location of the block to retrieve a sculk spreader from.
      * @throws This function can throw errors.
@@ -1130,12 +1394,18 @@ export class Test {
      * Returns the direction of the current test - see the {@link
      * @minecraft/server.Direction} enum for more information on
      * potential values (north, east, south, west - values 2-5).
+     *
+     * This function can't be called in read-only mode.
+     *
      */
     getTestDirection(): minecraftserver.Direction;
     /**
      * @remarks
      * This asynchronous function will wait for the specified time
      * in ticks before continuing execution.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param tickDelay
      * Amount of time to wait, in ticks.
      */
@@ -1143,13 +1413,25 @@ export class Test {
     /**
      * @remarks
      * Kills all entities within the GameTest structure.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     killAllEntities(): void;
+    /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
+     * @throws This function can throw errors.
+     */
     onPlayerJump(mob: minecraftserver.Entity, jumpAmount: number): void;
     /**
      * @remarks
      * Presses a button at a block location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location to push the button at.
      * @throws
@@ -1160,6 +1442,9 @@ export class Test {
     /**
      * @remarks
      * Displays the specified message to all players.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param text
      * Message to display.
      * @throws This function can throw errors.
@@ -1168,6 +1453,9 @@ export class Test {
     /**
      * @remarks
      * Pulls a lever at a block location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location to pull the lever at.
      * @throws
@@ -1179,6 +1467,9 @@ export class Test {
      * @remarks
      * Sends a Redstone pulse at a particular location by creating
      * a temporary Redstone block.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location to pulse Redstone at.
      * @param duration
@@ -1193,6 +1484,9 @@ export class Test {
      * block. For example, the relative coordinates for the block
      * above the structure block are (0, 1, 0). Rotation of the
      * GameTest structure is also taken into account.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param worldBlockLocation
      * Absolute location in the world to convert to a relative
      * location.
@@ -1208,6 +1502,9 @@ export class Test {
      * example, the relative coordinates for the block above the
      * structure block are (0, 1, 0). Rotation of the GameTest
      * structure is also taken into account.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param worldLocation
      * Absolute location in the world to convert to a relative
      * location.
@@ -1219,6 +1516,9 @@ export class Test {
     /**
      * @remarks
      * Removes a simulated player from the world.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param simulatedPlayer
      * Simulated player to remove.
      */
@@ -1229,6 +1529,9 @@ export class Test {
      * the current test. Passing in Direction.south will return the
      * test direction; Passing in Direction.north will return the
      * opposite of the test direction, and so on.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param direction
      * Direction to translate into a direction relative to the
      * GameTest facing. Passing in Direction.south will return the
@@ -1238,12 +1541,18 @@ export class Test {
      */
     rotateDirection(direction: minecraftserver.Direction): minecraftserver.Direction;
     /**
+     * @remarks
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     rotateVector(vector: minecraftserver.Vector): minecraftserver.Vector;
     /**
      * @remarks
      * Runs a specific callback after a specified delay of ticks
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param delayTicks
      * Number of ticks to delay before running the specified
      * callback.
@@ -1256,6 +1565,9 @@ export class Test {
      * @remarks
      * Runs the given callback after a delay of _tick_ ticks from
      * the start of the GameTest.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param tick
      * Tick (after the start of the GameTest) to run the callback
      * at.
@@ -1268,6 +1580,9 @@ export class Test {
      * @remarks
      * Sets a block to a particular configuration (a
      * BlockPermutation) at the specified block location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockData
      * Permutation that contains the configuration data for a
      * block.
@@ -1280,6 +1595,9 @@ export class Test {
      * @remarks
      * Sets a block to a particular type at the specified block
      * location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockType
      * Type of block to set.
      * @param blockLocation
@@ -1291,6 +1609,9 @@ export class Test {
      * @remarks
      * For blocks that are fluid containers - like a cauldron -
      * changes the type of fluid within that container.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param location
      * Location of the fluid container block.
      * @param type
@@ -1302,6 +1623,9 @@ export class Test {
     /**
      * @remarks
      * Sets the fuse of an explodable entity.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entity
      * Entity that is explodable.
      * @param fuseLength
@@ -1312,6 +1636,9 @@ export class Test {
     /**
      * @remarks
      * Spawns an entity at a location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to create. If no namespace is provided,
      * 'minecraft:' is assumed. Note that an optional initial spawn
@@ -1351,6 +1678,9 @@ export class Test {
     /**
      * @remarks
      * Spawns an entity at a location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to create. If no namespace is provided,
      * 'minecraft:' is assumed. Note that an optional initial spawn
@@ -1370,6 +1700,9 @@ export class Test {
     /**
      * @remarks
      * Spawns an item entity at a specified location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param itemStack
      * ItemStack that describes the item entity to create.
      * @param location
@@ -1390,6 +1723,9 @@ export class Test {
     /**
      * @remarks
      * Creates a new simulated player within the world.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location where to spawn the simulated player.
      * @param name
@@ -1406,6 +1742,9 @@ export class Test {
      * Spawns an entity at a location without any AI behaviors.
      * This method is frequently used in conjunction with methods
      * like .walkTo to create predictable mob actions.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * Location where the entity should be spawned.
      * @throws This function can throw errors.
@@ -1416,6 +1755,9 @@ export class Test {
      * Spawns an entity at a location without any AI behaviors.
      * This method is frequently used in conjunction with methods
      * like .walkTo to create predictable mob actions.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param location
      * Location where the entity should be spawned.
      * @throws This function can throw errors.
@@ -1428,6 +1770,9 @@ export class Test {
      * @remarks
      * Tests that a particular item entity is present at a
      * particular location. If not, an exception is thrown.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockLocation
      * BlockLocation containing a multiface block.
      * @param fromFace
@@ -1451,6 +1796,9 @@ export class Test {
      * @remarks
      * Creates a new GameTestSequence - A set of steps that play
      * out sequentially within a GameTest.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @returns
      * A new GameTestSequence with chaining methods that facilitate
      * creating a set of steps.
@@ -1459,6 +1807,9 @@ export class Test {
     /**
      * @remarks
      * Marks the current test as a success case.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @throws This function can throw errors.
      */
     succeed(): void;
@@ -1466,6 +1817,9 @@ export class Test {
      * @remarks
      * Runs the given callback. If the callback does not throw an
      * exception, the test is marked as a success.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Callback function that runs. If the function runs
      * successfully, the test is marked as a success. Typically,
@@ -1476,6 +1830,9 @@ export class Test {
     /**
      * @remarks
      * Marks the test as a success at the specified tick.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param tick
      * Tick after the start of the GameTest to mark the test as
      * successful.
@@ -1487,6 +1844,9 @@ export class Test {
      * Runs the given callback at _tick_ ticks after the start of
      * the test. If the callback does not throw an exception, the
      * test is marked as a failure.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param tick
      * Tick after the start of the GameTest to run the testing
      * callback at.
@@ -1502,6 +1862,9 @@ export class Test {
      * successfully executes, the test is marked as a success.
      * Specifically, the test will succeed when the callback does
      * not throw an exception.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Testing callback function that runs. If the function runs
      * successfully, the test is marked as a success.
@@ -1534,6 +1897,9 @@ export class Test {
      * presence of a block of a particular type on every tick. When
      * the specified block of a type is found or not found
      * (depending on isPresent), the test is marked as a success.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param blockType
      * Type of block to test for.
      * @param blockLocation
@@ -1554,6 +1920,9 @@ export class Test {
      * Tests for the presence of a component on every tick.
      * Depending on the value of hasComponent, when the specified
      * component is found, the test is marked as a success.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to look for. If no namespace is specified,
      * 'minecraft:' is assumed.
@@ -1580,6 +1949,9 @@ export class Test {
      * of an entity on every tick. When an entity of the specified
      * type is found or not found (depending on isPresent), the
      * test is marked as a success.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param entityTypeIdentifier
      * Type of entity to test for (e.g., 'minecraft:skeleton'). If
      * an entity namespace is not specified, 'minecraft:' is
@@ -1601,6 +1973,9 @@ export class Test {
      * @remarks
      * Triggers a block event from a fixed list of available block
      * events.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param event
      * Event to trigger. Valid values include minecraft:drip,
      * minecraft:grow_stalagtite, minecraft:grow_stalagmite,
@@ -1615,6 +1990,9 @@ export class Test {
      * specified callback successfully completes. until can be used
      * in conjunction with .assert functions to evaluate that a
      * condition is true.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param callback
      * Function with code to evaluate.
      */
@@ -1625,6 +2003,9 @@ export class Test {
      * in conjunction with methods like .spawnWithoutBehaviors to
      * have more predictable mob behaviors. Mobs will stop
      * navigation as soon as they intersect the target location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param mob
      * Mob entity to give orders to.
      * @param blockLocation
@@ -1640,6 +2021,9 @@ export class Test {
      * in conjunction with methods like .spawnWithoutBehaviors to
      * have more predictable mob behaviors. Mobs will stop
      * navigation as soon as they intersect the target location.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param mob
      * Mob entity to give orders to.
      * @param location
@@ -1655,6 +2039,9 @@ export class Test {
      * GameTest structure block, returns a new BlockLocation with
      * coordinates relative to world. Rotation of the GameTest
      * structure is also taken into account.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param relativeBlockLocation
      * Location relative to the GameTest command block.
      * @returns
@@ -1668,6 +2055,9 @@ export class Test {
      * structure block, returns a new location with coordinates
      * relative to world. Rotation of the GameTest structure is
      * also taken into account.
+     *
+     * This function can't be called in read-only mode.
+     *
      * @param relativeLocation
      * Location relative to the GameTest command block.
      * @returns
@@ -1676,22 +2066,28 @@ export class Test {
      */
     worldLocation(relativeLocation: minecraftserver.Vector3): minecraftserver.Vector3;
 }
+
 export interface GameTestErrorContext {
     absolutePosition: minecraftserver.Vector3;
     relativePosition: minecraftserver.Vector3;
     tickCount: number;
 }
+
 export class GameTestError extends Error {
     protected constructor();
     context?: GameTestErrorContext;
     messageParameters: string[];
     type: GameTestErrorType;
 }
+
 /**
  * @remarks
  * Registers a new GameTest function. This GameTest will become
  * available in Minecraft via /gametest run
  * [testClassName]:[testName].
+ *
+ * This function can't be called in read-only mode.
+ *
  * @param testClassName
  * Name of the class of tests this test should be a part of.
  * @param testName
@@ -1739,6 +2135,9 @@ export function register(
  * Registers a new GameTest function that is designed for
  * asynchronous execution. This GameTest will become available
  * in Minecraft via /gametest run [testClassName]:[testName].
+ *
+ * This function can't be called in read-only mode.
+ *
  * @param testClassName
  * Name of the class of tests this test should be a part of.
  * @param testName

package/package.json

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