Class RegistrationBuilder`Beta`

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

Index

Constructors

constructor

Methods

batch maxAttempts maxTicks padding required requiredSuccessfulAttempts rotateTest setupTicks structureName tag

Constructors

`Private`constructor

new RegistrationBuilder(): RegistrationBuilder
Beta
Returns RegistrationBuilder
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:217

Methods

batch

batch(batchName: string): RegistrationBuilder
Beta
Parameters
- batchName: string
  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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:230

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:242

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:254

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:269

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:284

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:296

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:305

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:317

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.

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:330

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

This function can't be called in read-only mode.
- Defined in ../../../../AppData/Roaming/.minecraft_bedrock/installations/Main Release/packageData/development_behavior_packs/DebugSticksAndScreens/node_modules/@minecraft/server-gametest/index.d.ts:342

Class RegistrationBuilderBeta

Index

Constructors

Methods

Constructors

Privateconstructor

Returns RegistrationBuilder

Methods

batch

Parameters

Returns RegistrationBuilder

Remarks

maxAttempts

Parameters

Returns RegistrationBuilder

Remarks

maxTicks

Parameters

Returns RegistrationBuilder

Remarks

padding

Parameters

Returns RegistrationBuilder

Remarks

required

Parameters

Returns RegistrationBuilder

Remarks

requiredSuccessfulAttempts

Parameters

Returns RegistrationBuilder

Remarks

rotateTest

Parameters

Returns RegistrationBuilder

Remarks

setupTicks

Parameters

Returns RegistrationBuilder

Remarks

structureName

Parameters

Returns RegistrationBuilder

Remarks

tag

Parameters

Returns RegistrationBuilder

Remarks

Settings

On This Page

Class RegistrationBuilder`Beta`

`Private`constructor