@minecraft
    Preparing search index...

    Class RegistrationBuilder

    A utility class to set GameTest parameters for a test. Methods can be chained together to set multiple properties.

    Index

    Methods

    batch maxAttempts maxTicks padding required requiredSuccessfulAttempts rotateTest setupTicks structureLocation structureName tag

    Methods

    • World mutation Early execution

      Parameters

      • paddingBlocks: number

        Size, in blocks, around the GameTest where additional GameTests should not be created.

      Returns RegistrationBuilder

      RegistrationBuilder object where additional configuration methods can be called.

      Size around the GameTest, in blocks, that should be reserved for the test when running multiple tests together.

    • World mutation Early execution

      Parameters

      • isRequired: boolean

        If set to true, the test must pass in order for the entire run of tests to pass.

      Returns RegistrationBuilder

      RegistrationBuilder object where additional configuration methods can be called.

      Whether this test is required to pass as part of its broader set of tests.

    • World mutation Early execution

      Parameters

      Returns RegistrationBuilder

      RegistrationBuilder object where additional configuration methods can be called.

      Overrides the default structure placement with a specific location and dimension. If height (y) is set to Dimension.heightRange.max, the structure will snap to the ground. If the dimension is not specified, it will run in the dimension the command was run from.

      This function can throw errors.

      EngineError

      InvalidArgumentError

    • World mutation Early execution

      Parameters

      • structureName: string

      Returns RegistrationBuilder

      RegistrationBuilder object where additional configuration methods can be called.

      Sets the name of the structure for a test to use. "xyz:bar" will load /structures/xyz/bar.mcstructure from the behavior pack stack.

      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");
    • World mutation Early execution

      Parameters

      • tag: string

      Returns RegistrationBuilder

      RegistrationBuilder object where additional configuration methods can be called.

      Adds a tag to a test. You can run all tests with a given tag with /gametest runset <tag>.

      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");

    Settings

    Member Visibility

    On This Page

    Methods