Class RegistrationBuilder`Beta`

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

Index

Constructors

Methods

batch maxAttempts maxTicks padding required requiredSuccessfulAttempts rotateTest setupTicks structureName tag

Constructors

`Protected`constructor

new RegistrationBuilder(): RegistrationBuilder
Beta
Returns RegistrationBuilder

Methods

batch

batch(batchName: "night" | "day"): RegistrationBuilder
Beta
Parameters
- batchName: "night" | "day"
  Name of the batch for the test.
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

Remarks
Sets the batch for the test to run in.

maxAttempts

maxAttempts(attemptCount: number): RegistrationBuilder
Beta
Parameters
- attemptCount: number
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

Remarks
Sets the maximum number of times a test will try to rerun if it fails.

maxTicks

maxTicks(tickCount: number): RegistrationBuilder
Beta
Parameters
- tickCount: number
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

Remarks
Sets the maximum number of ticks a test will run for before timing out and failing.

padding

padding(paddingBlocks: number): RegistrationBuilder
Beta
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.

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

required

required(isRequired: boolean): RegistrationBuilder
Beta
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.

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

requiredSuccessfulAttempts

requiredSuccessfulAttempts(attemptCount: number): RegistrationBuilder
Beta
Parameters
- attemptCount: number
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

Remarks
Sets the number of successful test runs to be considered successful.

rotateTest

rotateTest(rotate: boolean): RegistrationBuilder
Beta
Parameters
- rotate: boolean
Returns RegistrationBuilder
Remarks
If true, runs the test in all four rotations when run via /gametest runset.

setupTicks

setupTicks(tickCount: number): RegistrationBuilder
Beta
Parameters
- tickCount: number
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

Remarks
Sets the number of ticks for a test to wait before executing when the structure is spawned.

structureName

structureName(structureName: string): RegistrationBuilder
Beta
Parameters
- structureName: string
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

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

tag

tag(tag: string): RegistrationBuilder
Beta
Parameters
- tag: string
Returns RegistrationBuilder
RegistrationBuilder object where additional configuration methods can be called.

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