类 Test实验性

Main class for GameTest functions, with helpers and data for manipulating the respective test. Note that all methods of this class expect BlockLocations and Locations relative to the GameTest structure block.

方法

assert assertBlockPresent assertBlockState assertCanReachLocation assertContainerContains assertContainerEmpty assertEntityHasArmor assertEntityHasComponent assertEntityInstancePresent assertEntityInstancePresentInArea assertEntityPresent assertEntityPresentInArea assertEntityState assertEntityTouching assertIsWaterlogged assertItemEntityCountIs assertItemEntityPresent assertRedstonePower destroyBlock fail failIf getBlock getDimension getFenceConnectivity getSculkSpreader getTestDirection idle killAllEntities onPlayerJump pressButton print pullLever pulseRedstone relativeBlockLocation relativeLocation removeSimulatedPlayer rotateDirection rotateVector runAfterDelay runAtTickTime setBlockPermutation setBlockType setFluidContainer setTntFuse spawn spawnAtLocation spawnItem spawnSimulatedPlayer spawnWithoutBehaviors spawnWithoutBehaviorsAtLocation spreadFromFaceTowardDirection startSequence succeed succeedIf succeedOnTick succeedOnTickWhen succeedWhen succeedWhenBlockPresent succeedWhenEntityHasComponent succeedWhenEntityPresent triggerInternalBlockEvent until walkTo walkToLocation worldBlockLocation worldLocation

方法

assert

  • assert(condition, message): void
  • 实验性

    参数

    • condition: boolean

      Expression of the condition to evaluate.

    • message: string

      Message that is passed if the condition does not evaluate to true.

    返回 void

    备注

    Tests that the condition specified in condition is true. If not, an error with the specified message is thrown.

    抛出

    This function can throw errors.

    GameTestError

assertBlockPresent

  • assertBlockPresent(blockType, blockLocation, isPresent?): void
  • 实验性

    参数

    • blockType: string | BlockType

      Expected block type.

    • blockLocation: Vector3

      Location of the block to test at.

    • 可选isPresent: boolean

      If true, this function tests whether a block of the specified type is at the location. If false, tests that a block of the specified type is not present.

    返回 void

    备注

    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 throw errors.

    GameTestError

assertBlockState

  • assertBlockState(blockLocation, callback): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location of the block to test at.

    • callback: ((arg: Block) => boolean)

      Callback function that contains additional tests based on the block at the specified location.

        • (arg): boolean

        • 参数

          返回 boolean

    返回 void

    备注

    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 throw errors.

    GameTestError

assertCanReachLocation

  • assertCanReachLocation(mob, blockLocation, canReach?): void
  • 实验性

    参数

    • mob: Entity

      Entity that you wish to test the location against.

    • blockLocation: Vector3

      Structure-relative location to test whether the specified mob can reach.

    • 可选canReach: boolean

      If true, tests whether the mob can reach the location. If false, tests whether the mob is not able to reach the location.

    返回 void

    备注

    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 throw errors.

    GameTestError

assertContainerContains

  • assertContainerContains(itemStack, blockLocation): void
  • 实验性

    参数

    • itemStack: ItemStack

      Represents the type of item to check for. The specified container must contain at least 1 item matching the item type defined in itemStack.

    • blockLocation: Vector3

      Location of the block with a container (for example, a chest) to test the contents of.

    返回 void

    备注

    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 throw errors.

    GameTestError

assertContainerEmpty

  • assertContainerEmpty(blockLocation): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location of the block with a container (for example, a chest) to test is empty of contents.

    返回 void

    备注

    Tests that a container (e.g., a chest) at the specified location is empty. If not, an error is thrown.

    抛出

    This function can throw errors.

    GameTestError

assertEntityHasArmor

  • assertEntityHasArmor(entityTypeIdentifier, armorSlot, armorName, armorData, blockLocation, hasArmor?): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Identifier of the entity to match (e.g., 'minecraft:skeleton').

    • armorSlot: number

      Container slot index to test.

    • armorName: string

      Name of the armor to look for.

    • armorData: number

      Data value integer to look for.

    • blockLocation: Vector3

      Location of the entity with armor to test for.

    • 可选hasArmor: boolean

      Whether or not the entity is expected to have the specified armor equipped.

    返回 void

    备注

    Tests that an entity has a specific piece of armor equipped. If not, an error is thrown.

    抛出

    This function can throw errors.

    GameTestError

assertEntityHasComponent

  • assertEntityHasComponent(entityTypeIdentifier, componentIdentifier, blockLocation, hasComponent?): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Identifier of the specified entity (e.g., 'minecraft:skeleton'). If the namespace is not specified, 'minecraft:' is assumed.

    • componentIdentifier: string

      Identifier of the component to check for. If the namespace is not specified, 'minecraft:' is assumed.

    • blockLocation: Vector3

      Location of the block with a container (for example, a chest.)

    • 可选hasComponent: boolean

      Determines whether to test that the component exists, or does not.

    返回 void

    备注

    Tests that an entity has a particular component. If not, an exception is thrown.

    抛出

    This function can throw errors.

    GameTestError

assertEntityInstancePresent

  • assertEntityInstancePresent(entity, blockLocation, isPresent?): void
  • 实验性

    参数

    • entity: Entity

      Specific entity to test for.

    • blockLocation: Vector3

      Location of the entity to test for.

    • 可选isPresent: boolean

      Whether to test that an entity is present or not present at the specified location.

    返回 void

    备注

    Depending on the value for isPresent, tests that a 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 throw errors.

    GameTestError

assertEntityInstancePresentInArea

  • assertEntityInstancePresentInArea(entity, isPresent?): void
  • 实验性

    参数

    • entity: Entity

      Entity instance to test for.

    • 可选isPresent: boolean

      If true, this function tests whether the specified entity is present in the GameTest area. If false, tests that the specified entity is not present.

    返回 void

    备注

    Tests that an entity instance is present within the GameTest area. If not, an exception is thrown.

    抛出

    This function can throw errors.

    GameTestError

    示例: simpleMobTest.ts

    import * as gameTest from '@minecraft/server-gametest';

    gameTest
        .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.assertEntityInstancePresentInArea(victim, true);

            test.succeedWhen(() => {
                test.assertEntityInstancePresentInArea(victim, false);
            });
        })
        .maxTicks(400)
        .structureName('gametests:mediumglass');

assertEntityPresent

  • assertEntityPresent(entityTypeIdentifier, blockLocation, searchDistance?, isPresent?): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to test for (e.g., 'minecraft:skeleton'). If an entity namespace is not specified, 'minecraft:' is assumed.

    • blockLocation: Vector3

      Location of the entity to test for.

    • 可选searchDistance: number

      The distance to search for the entity from the blockLocation.

    • 可选isPresent: boolean

      If true, this function tests whether an entity of the specified type is present. If false, tests that an entity of the specified type is not present.

    返回 void

    备注

    Depending on the value of isPresent, tests for the presence 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 throw errors.

    GameTestError

assertEntityPresentInArea

  • assertEntityPresentInArea(entityTypeIdentifier, isPresent?): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to test for (e.g., 'minecraft:skeleton'). If an entity namespace is not specified, 'minecraft:' is assumed.

    • 可选isPresent: boolean

      If true, this function tests whether an entity of the specified type is present in the GameTest area. If false, tests that an entity of the specified type is not present.

    返回 void

    备注

    Tests that an entity of a specified type is present within the GameTest area. If not, an exception is thrown.

    抛出

    This function can throw errors.

    GameTestError

    示例: simpleMobTest.ts

    import * as gameTest from '@minecraft/server-gametest';

    gameTest
        .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.assertEntityPresentInArea(victimId, true);

            test.succeedWhen(() => {
                test.assertEntityPresentInArea(victimId, false);
            });
        })
        .maxTicks(400)
        .structureName('gametests:mediumglass');

    示例: simpleMobGameTest.ts

    import { Test, register } from "@minecraft/server-gametest";
    import { MinecraftEntityTypes } from "@minecraft/vanilla-data";

    function simpleMobGameTest(test: Test) {
      const attackerId = MinecraftEntityTypes.Fox;
      const victimId = MinecraftEntityTypes.Chicken;

      test.spawn(attackerId, { x: 5, y: 2, z: 5 });
      test.spawn(victimId, { x: 2, y: 2, z: 2 });

      test.assertEntityPresentInArea(victimId, true);

      test.succeedWhen(() => {
        test.assertEntityPresentInArea(victimId, false);
      });
    }
    register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");

assertEntityState

  • assertEntityState(blockLocation, entityTypeIdentifier, callback): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location of the entity to look for.

    • entityTypeIdentifier: string

      Identifier of the entity (e.g., 'minecraft:skeleton') to look for. Note if no namespace is specified, 'minecraft:' is assumed.

    • callback: ((arg: Entity) => boolean)

      Callback function where facets of the selected entity can be tested for. If this callback function returns false or no entity with the specified identifier is found, an exception is thrown.

        • (arg): boolean

        • 参数

          返回 boolean

    返回 void

    备注

    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 throw errors.

    GameTestError

assertEntityTouching

  • assertEntityTouching(entityTypeIdentifier, location, isTouching?): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to test for (e.g., 'minecraft:skeleton'). If an entity namespace is not specified, 'minecraft:' is assumed.

    • location: Vector3

      Location of the entity to test for.

    • 可选isTouching: boolean

      If true, this function tests whether the entity is touching the specified location. If false, tests that an entity is not testing the specified location.

    返回 void

    备注

    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 throw errors.

    GameTestError

assertIsWaterlogged

  • assertIsWaterlogged(blockLocation, isWaterlogged?): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location of the block to test for.

    • 可选isWaterlogged: boolean

      Whether to test that the block at position is expected to be waterlogged.

    返回 void

    备注

    Depending on the value of isWaterlogged, tests that a block 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 throw errors.

    GameTestError

assertItemEntityCountIs

  • assertItemEntityCountIs(itemType, blockLocation, searchDistance, count): void
  • 实验性

    参数

    • itemType: string | ItemType

      Type of item to look for.

    • blockLocation: Vector3

      Location to search around for the specified set of items.

    • searchDistance: number

      Range, in blocks, to aggregate a count of items around. If 0, will only search the particular block at position.

    • count: number

      Number of items, at minimum, to look and test for.

    返回 void

    备注

    Tests that items of a particular type and count are present within an area. If not, an error is thrown.

    抛出

    This function can throw errors.

    GameTestError

assertItemEntityPresent

  • assertItemEntityPresent(itemType, blockLocation, searchDistance?, isPresent?): void
  • 实验性

    参数

    • itemType: string | ItemType

      Type of item to test for.

    • blockLocation: Vector3

      Location of the item entity to test for.

    • 可选searchDistance: number

      Radius in blocks to look for the item entity.

    • 可选isPresent: boolean

      If true, this function tests whether an item entity of the specified type is present. If false, tests that an item entity of the specified type is not present.

    返回 void

    备注

    Depending on the value of isPresent, tests whether a particular item entity is present or not at a particular location. If the condition is not met, an exception is thrown.

    抛出

    This function can throw errors.

    GameTestError

assertRedstonePower

  • assertRedstonePower(blockLocation, power): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location to test.

    • power: number

      Expected power level.

    返回 void

    备注

    Tests that Redstone power at a particular location matches a particular value. If not, an exception is thrown.

    抛出

    This function can throw errors.

    GameTestError

destroyBlock

  • destroyBlock(blockLocation, dropResources?): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location of the block to destroy.

    • 可选dropResources: boolean

      Whether to add resources exposed with a particular drop.

    返回 void

    备注

    Destroys a block at a particular location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

fail

  • fail(errorMessage): void
  • 实验性

    参数

    • errorMessage: string

      Error message summarizing the failure condition.

    返回 void

    备注

    Marks the current test as a failure case.

    抛出

    This function can throw errors.

failIf

  • failIf(callback): void
  • 实验性

    参数

    • callback: (() => void)

      Callback function that runs. If the function runs successfully, the test is marked as a failure. Typically, this function will have .assertXyz method calls within it.

        • (): void

        • 返回 void

    返回 void

    备注

    Runs the given callback. If the callback does not throw an exception, the test is marked as a failure.

    抛出

    This function can throw errors.

getBlock

getDimension

getFenceConnectivity

getSculkSpreader

  • getSculkSpreader(blockLocation): SculkSpreader
  • 实验性

    参数

    • blockLocation: Vector3

      Location of the block to retrieve a sculk spreader from.

    返回 SculkSpreader

    Returns the SculkSpreader or undefined if no SculkSpreader is present on the block.

    备注

    Retrieves a sculk spreader object that can be used to control and manage how sculk grows from a block.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

getTestDirection

idle

  • idle(tickDelay): Promise<void>
  • 实验性

    参数

    • tickDelay: number

      Amount of time to wait, in ticks.

    返回 Promise<void>

    备注

    This asynchronous function will wait for the specified time in ticks before continuing execution.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

killAllEntities

onPlayerJump

pressButton

  • pressButton(blockLocation): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location to push the button at.

    返回 void

    备注

    Presses a button at a block location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    Will throw an error if a button is not present at the specified position.

    GameTestError

print

pullLever

pulseRedstone

  • pulseRedstone(blockLocation, duration): void
  • 实验性

    参数

    • blockLocation: Vector3

      Location to pulse Redstone at.

    • duration: number

      Number of ticks to pulse Redstone.

    返回 void

    备注

    Sends a Redstone pulse at a particular location by creating a temporary Redstone block.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

relativeBlockLocation

  • relativeBlockLocation(worldBlockLocation): Vector3
  • 实验性

    参数

    • worldBlockLocation: Vector3

      Absolute location in the world to convert to a relative location.

    返回 Vector3

    A location relative to the GameTest command block.

    备注

    From a BlockLocation, returns a new BlockLocation with coordinates relative to the current GameTest structure 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 throw errors.

    minecraftserver.GameTestError

relativeLocation

  • relativeLocation(worldLocation): Vector3
  • 实验性

    参数

    • worldLocation: Vector3

      Absolute location in the world to convert to a relative location.

    返回 Vector3

    A location relative to the GameTest command block.

    备注

    From a location, returns a new location with coordinates relative to the current GameTest structure 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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

removeSimulatedPlayer

rotateDirection

  • rotateDirection(direction): Direction
  • 实验性

    参数

    • direction: Direction

      Direction to translate into a direction relative to the GameTest facing. Passing in Direction.south will return the test direction; Passing in Direction.north will return the opposite of the test direction, and so on.

    返回 Direction

    备注

    Returns a relative direction given the current rotation of 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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

rotateVector

runAfterDelay

  • runAfterDelay(delayTicks, callback): void
  • 实验性

    参数

    • delayTicks: number

      Number of ticks to delay before running the specified callback.

    • callback: (() => void)

      Callback function to execute.

        • (): void

        • 返回 void

    返回 void

    备注

    Runs a specific callback after a specified delay of ticks

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

runAtTickTime

  • runAtTickTime(tick, callback): void
  • 实验性

    参数

    • tick: number

      Tick (after the start of the GameTest) to run the callback at.

    • callback: (() => void)

      Callback function to execute.

        • (): void

        • 返回 void

    返回 void

    备注

    Runs the given callback after a delay of tick ticks from the start of the GameTest.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

setBlockPermutation

  • setBlockPermutation(blockData, blockLocation): void
  • 实验性

    参数

    • blockData: BlockPermutation

      Permutation that contains the configuration data for a block.

    • blockLocation: Vector3

      Location of the block to set.

    返回 void

    备注

    Sets a block to a particular configuration (a BlockPermutation) at the specified block location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

setBlockType

  • setBlockType(blockType, blockLocation): void
  • 实验性

    参数

    • blockType: string | BlockType

      Type of block to set.

    • blockLocation: Vector3

      Location of the block to set.

    返回 void

    备注

    Sets a block to a particular type at the specified block location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

    示例: minibiomes.ts

    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 });
      const pig = test.spawn(MinecraftEntityTypes.Pig, { x: 9, y: 7, z: 7 });

      test.setBlockType(MinecraftBlockTypes.Cobblestone, { x: 10, y: 7, z: 7 });

      const minecartRideableComp = minecart.getComponent(EntityComponentTypes.Rideable);

      minecartRideableComp?.addRider(pig);

      test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
    }
    register("ChallengeTests", "minibiomes", minibiomes).structureName("gametests:minibiomes").maxTicks(160);

setFluidContainer

setTntFuse

  • setTntFuse(entity, fuseLength): void
  • 实验性

    参数

    • entity: Entity

      Entity that is explodable.

    • fuseLength: number

      Length of time, in ticks, before the entity explodes.

    返回 void

    备注

    Sets the fuse of an explodable entity.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

spawn

  • spawn(entityTypeIdentifier, blockLocation): Entity
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to create. If no namespace is provided, 'minecraft:' is assumed. Note that an optional initial spawn event can be specified between less than/greater than signs (e.g., namespace:entityType).

    • blockLocation: Vector3

    返回 Entity

    The spawned entity. If the entity cannot be spawned, returns undefined.

    备注

    Spawns an entity at a location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

    示例: simpleMobTest.ts

    import * as gameTest from '@minecraft/server-gametest';

    gameTest
        .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.assertEntityPresentInArea(victimId, true);

            test.succeedWhen(() => {
                test.assertEntityPresentInArea(victimId, false);
            });
        })
        .maxTicks(400)
        .structureName('gametests:mediumglass');

    示例: simpleMobGameTest.ts

    import { Test, register } from "@minecraft/server-gametest";
    import { MinecraftEntityTypes } from "@minecraft/vanilla-data";

    function simpleMobGameTest(test: Test) {
      const attackerId = MinecraftEntityTypes.Fox;
      const victimId = MinecraftEntityTypes.Chicken;

      test.spawn(attackerId, { x: 5, y: 2, z: 5 });
      test.spawn(victimId, { x: 2, y: 2, z: 2 });

      test.assertEntityPresentInArea(victimId, true);

      test.succeedWhen(() => {
        test.assertEntityPresentInArea(victimId, false);
      });
    }
    register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");

    示例: phantomsShouldFlyFromCats.ts

    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 });
      test.spawn(MinecraftEntityTypes.Phantom, { x: 4, y: 3, z: 3 });

      test.succeedWhenEntityPresent(MinecraftEntityTypes.Phantom, { x: 4, y: 6, z: 3 }, true);
    }

    register("MobBehaviorTests", "phantoms_should_fly_from_cats", phantomsShouldFlyFromCats)
      .structureName("gametests:glass_cells");

    示例: minibiomes.ts

    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 });
      const pig = test.spawn(MinecraftEntityTypes.Pig, { x: 9, y: 7, z: 7 });

      test.setBlockType(MinecraftBlockTypes.Cobblestone, { x: 10, y: 7, z: 7 });

      const minecartRideableComp = minecart.getComponent(EntityComponentTypes.Rideable);

      minecartRideableComp?.addRider(pig);

      test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
    }
    register("ChallengeTests", "minibiomes", minibiomes).structureName("gametests:minibiomes").maxTicks(160);

spawnAtLocation

  • spawnAtLocation(entityTypeIdentifier, location): Entity
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to create. If no namespace is provided, 'minecraft:' is assumed. Note that an optional initial spawn event can be specified between less than/greater than signs (e.g., namespace:entityType).

    • location: Vector3

    返回 Entity

    The spawned entity. If the entity cannot be spawned, returns undefined.

    备注

    Spawns an entity at a location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

spawnItem

spawnSimulatedPlayer

spawnWithoutBehaviors

  • spawnWithoutBehaviors(entityTypeIdentifier, blockLocation): Entity
  • 实验性

    参数

    • entityTypeIdentifier: string
    • blockLocation: Vector3

      Location where the entity should be spawned.

    返回 Entity

    备注

    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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

spawnWithoutBehaviorsAtLocation

  • spawnWithoutBehaviorsAtLocation(entityTypeIdentifier, location): Entity
  • 实验性

    参数

    • entityTypeIdentifier: string
    • location: Vector3

      Location where the entity should be spawned.

    返回 Entity

    备注

    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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

spreadFromFaceTowardDirection

  • spreadFromFaceTowardDirection(blockLocation, fromFace, direction): void
  • 实验性

    参数

    • blockLocation: Vector3

      BlockLocation containing a multiface block.

    • fromFace: Direction

      Face to spread from. This face must already be set.

    • direction: Direction

      Direction to spread. Use the Minecraft.Direction enum to specify a direction.

    返回 void

    备注

    Tests that a particular item entity is present at a particular location. If not, an exception is thrown.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

startSequence

succeed

succeedIf

  • succeedIf(callback): void
  • 实验性

    参数

    • callback: (() => void)

      Callback function that runs. If the function runs successfully, the test is marked as a success. Typically, this function will have .assertXyz method calls within it.

        • (): void

        • 返回 void

    返回 void

    备注

    Runs the given callback. If the callback does not throw an exception, the test is marked as a success.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

succeedOnTick

  • succeedOnTick(tick): void
  • 实验性

    参数

    • tick: number

      Tick after the start of the GameTest to mark the test as successful.

    返回 void

    备注

    Marks the test as a success at the specified tick.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

succeedOnTickWhen

  • succeedOnTickWhen(tick, callback): void
  • 实验性

    参数

    • tick: number

      Tick after the start of the GameTest to run the testing callback at.

    • callback: (() => void)

      Callback function that runs. If the function runs successfully, the test is marked as a success.

        • (): void

        • 返回 void

    返回 void

    备注

    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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

succeedWhen

  • succeedWhen(callback): void
  • 实验性

    参数

    • callback: (() => void)

      Testing callback function that runs. If the function runs successfully, the test is marked as a success.

        • (): void

        • 返回 void

    返回 void

    备注

    Runs the given callback every tick. When the callback successfully executes, the test is marked as a success. Specifically, the test will succeed when the callback does not throw an exception.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    示例: simpleMobGameTest.ts

    import { Test, register } from "@minecraft/server-gametest";
    import { MinecraftEntityTypes } from "@minecraft/vanilla-data";

    function simpleMobGameTest(test: Test) {
      const attackerId = MinecraftEntityTypes.Fox;
      const victimId = MinecraftEntityTypes.Chicken;

      test.spawn(attackerId, { x: 5, y: 2, z: 5 });
      test.spawn(victimId, { x: 2, y: 2, z: 2 });

      test.assertEntityPresentInArea(victimId, true);

      test.succeedWhen(() => {
        test.assertEntityPresentInArea(victimId, false);
      });
    }
    register("StarterTests", "simpleMobTest", simpleMobGameTest).maxTicks(400).structureName("gametests:mediumglass");

succeedWhenBlockPresent

  • succeedWhenBlockPresent(blockType, blockLocation, isPresent?): void
  • 实验性

    参数

    • blockType: string | BlockType

      Type of block to test for.

    • blockLocation: Vector3

      Location of the block to test at.

    • 可选isPresent: boolean

      If true, this function tests whether a block of the specified type is present. If false, tests that a block of the specified type is not present.

    返回 void

    备注

    Depending on the condition of isPresent, tests for the 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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

succeedWhenEntityHasComponent

  • succeedWhenEntityHasComponent(entityTypeIdentifier, componentIdentifier, blockLocation, hasComponent): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to look for. If no namespace is specified, 'minecraft:' is assumed.

    • componentIdentifier: string

      Type of component to test for the presence of. If no namespace is specified, 'minecraft:' is assumed.

    • blockLocation: Vector3

      Block location of the entity to test.

    • hasComponent: boolean

      If true, this function tests for the presence of a component. If false, this function tests for the lack of a component.

    返回 void

    备注

    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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

succeedWhenEntityPresent

  • succeedWhenEntityPresent(entityTypeIdentifier, blockLocation, isPresent?): void
  • 实验性

    参数

    • entityTypeIdentifier: string

      Type of entity to test for (e.g., 'minecraft:skeleton'). If an entity namespace is not specified, 'minecraft:' is assumed.

    • blockLocation: Vector3

      Location of the entity to test for.

    • 可选isPresent: boolean

      If true, this function tests whether an entity of the specified type is present. If false, tests that an entity of the specified type is not present.

    返回 void

    备注

    Depending on the value of isPresent, tests for the presence 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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    示例: phantomsShouldFlyFromCats.ts

    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 });
      test.spawn(MinecraftEntityTypes.Phantom, { x: 4, y: 3, z: 3 });

      test.succeedWhenEntityPresent(MinecraftEntityTypes.Phantom, { x: 4, y: 6, z: 3 }, true);
    }

    register("MobBehaviorTests", "phantoms_should_fly_from_cats", phantomsShouldFlyFromCats)
      .structureName("gametests:glass_cells");

    示例: minibiomes.ts

    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 });
      const pig = test.spawn(MinecraftEntityTypes.Pig, { x: 9, y: 7, z: 7 });

      test.setBlockType(MinecraftBlockTypes.Cobblestone, { x: 10, y: 7, z: 7 });

      const minecartRideableComp = minecart.getComponent(EntityComponentTypes.Rideable);

      minecartRideableComp?.addRider(pig);

      test.succeedWhenEntityPresent(MinecraftEntityTypes.Pig, { x: 8, y: 3, z: 1 }, true);
    }
    register("ChallengeTests", "minibiomes", minibiomes).structureName("gametests:minibiomes").maxTicks(160);

triggerInternalBlockEvent

  • triggerInternalBlockEvent(blockLocation, event, eventParameters?): void
  • 实验性

    参数

    • blockLocation: Vector3
    • event: string

      Event to trigger. Valid values include minecraft:drip, minecraft:grow_stalagtite, minecraft:grow_stalagmite, minecraft:grow_up, minecraft:grow_down and minecraft:grow_sideways.

    • 可选eventParameters: number[]

    返回 void

    备注

    Triggers a block event from a fixed list of available block events.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

until

  • until(callback): Promise<void>
  • 实验性

    参数

    • callback: (() => void)

      Function with code to evaluate.

        • (): void

        • 返回 void

    返回 Promise<void>

    备注

    This asynchronous function will wait until the code in the specified callback successfully completes. until can be used in conjunction with .assert functions to evaluate that a condition is true.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

walkTo

  • walkTo(mob, blockLocation, speedModifier?): void
  • 实验性

    参数

    • mob: Entity

      Mob entity to give orders to.

    • blockLocation: Vector3

      Location where the entity should be walk to.

    • 可选speedModifier: number

      Adjustable modifier to the mob's walking speed.

    返回 void

    备注

    Forces a mob to walk to a particular location. Usually used in conjunction with methods like .spawnWithoutBehaviors to have more predictable mob behaviors. Mobs will stop navigation as soon as they intersect the target location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

walkToLocation

  • walkToLocation(mob, location, speedModifier?): void
  • 实验性

    参数

    • mob: Entity

      Mob entity to give orders to.

    • location: Vector3

      Location where the entity should be walk to.

    • 可选speedModifier: number

      Adjustable modifier to the mob's walking speed.

    返回 void

    备注

    Forces a mob to walk to a particular location. Usually used in conjunction with methods like .spawnWithoutBehaviors to have more predictable mob behaviors. Mobs will stop navigation as soon as they intersect the target location.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    This function can throw errors.

    GameTestError

worldBlockLocation

  • worldBlockLocation(relativeBlockLocation): Vector3
  • 实验性

    参数

    • relativeBlockLocation: Vector3

      Location relative to the GameTest command block.

    返回 Vector3

    An absolute location relative to the GameTest command block.

    备注

    From a BlockLocation with coordinates relative to the 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 throw errors.

    minecraftserver.GameTestError

worldLocation

  • worldLocation(relativeLocation): Vector3
  • 实验性

    参数

    • relativeLocation: Vector3

      Location relative to the GameTest command block.

    返回 Vector3

    An absolute location relative to the GameTest command block.

    备注

    From a location with coordinates relative to the GameTest structure block, returns a new location with coordinates relative to world. Rotation of the GameTest structure is also taken into account.

    抛出

    This function can throw errors.

    minecraftserver.GameTestError

显示设置

成员可见性

目录

方法
assertassertBlockPresentassertBlockStateassertCanReachLocationassertContainerContainsassertContainerEmptyassertEntityHasArmorassertEntityHasComponentassertEntityInstancePresentassertEntityInstancePresentInAreaassertEntityPresentassertEntityPresentInAreaassertEntityStateassertEntityTouchingassertIsWaterloggedassertItemEntityCountIsassertItemEntityPresentassertRedstonePowerdestroyBlockfailfailIfgetBlockgetDimensiongetFenceConnectivitygetSculkSpreadergetTestDirectionidlekillAllEntitiesonPlayerJumppressButtonprintpullLeverpulseRedstonerelativeBlockLocationrelativeLocationremoveSimulatedPlayerrotateDirectionrotateVectorrunAfterDelayrunAtTickTimesetBlockPermutationsetBlockTypesetFluidContainersetTntFusespawnspawnAtLocationspawnItemspawnSimulatedPlayerspawnWithoutBehaviorsspawnWithoutBehaviorsAtLocationspreadFromFaceTowardDirectionstartSequencesucceedsucceedIfsucceedOnTicksucceedOnTickWhensucceedWhensucceedWhenBlockPresentsucceedWhenEntityHasComponentsucceedWhenEntityPresenttriggerInternalBlockEventuntilwalkTowalkToLocationworldBlockLocationworldLocation