For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server-editor/classes/BlockUtilityTasks.md.

Class: BlockUtilityTasks experimental

block

Beta

Methods

extrude()

extrude(location, direction?, faceRadius?, layerCount?, isShrink?, criteria?, customBlockList?, maxBlocksPerTick?, buildGeometry?, tolerance?, faceVolume?): VolumeTaskPromise

World Mutation Beta

Parameters

location

Vector3

direction?

BlockUtilityExtrudeDirection

faceRadius?

number

layerCount?

number

isShrink?

boolean

criteria?

BlockUtilityFloodMatchCriteria

customBlockList?

string[]

maxBlocksPerTick?

number

buildGeometry?

boolean

tolerance?

number

faceVolume?

any

Returns

VolumeTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


fillVolume()

fillVolume(volume, block?, maxBlocksPerTick?): NumberTaskPromise

World Mutation Beta

Parameters

volume

any

block?

any

maxBlocksPerTick?

number

Returns

NumberTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


findObscuredBlocksWithinVolume()

findObscuredBlocksWithinVolume(volume, maxBlocksPerTick?): VolumeTaskPromise

World Mutation Beta

Parameters

volume

any

maxBlocksPerTick?

number

Returns

VolumeTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


floodSearch()

floodSearch(location, criteria?, radius?, customBlockList?, maxResultBlocks?, maxBlocksPerTick?, directionMask?): VolumeTaskPromise

World Mutation Beta

Parameters

location

Vector3

criteria?

BlockUtilityFloodMatchCriteria

radius?

number

customBlockList?

string[]

maxResultBlocks?

number

maxBlocksPerTick?

number

directionMask?

number

Returns

VolumeTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


generateManifest()

generateManifest(volume, maxBlocksPerTick?): ManifestTaskPromise

World Mutation Beta

Parameters

volume

any

maxBlocksPerTick?

number

Returns

ManifestTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


replaceBlocksInSelection()

replaceBlocksInSelection(volume, fromBlockIdentifier, toBlock?, maxBlocksPerTick?): NumberTaskPromise

World Mutation Beta

Parameters

volume

any

fromBlockIdentifier

string

toBlock?

any

maxBlocksPerTick?

number

Returns

NumberTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


shrinkWrapVolume()

shrinkWrapVolume(volume, maxBlocksPerTick?): VolumeTaskPromise

World Mutation Beta

Parameters

volume

any

maxBlocksPerTick?

number

Returns

VolumeTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.


trimVolumeToFitContents()

trimVolumeToFitContents(volume, retainMarqueeAfterTrimming, ignoreLiquid, ignoreNoCollision, blockMask?, maxBlocksPerTick?): VolumeTaskPromise

World Mutation Beta

Parameters

volume

any

retainMarqueeAfterTrimming

boolean

ignoreLiquid

boolean

ignoreNoCollision

boolean

blockMask?

BlockMaskList

maxBlocksPerTick?

number

Returns

VolumeTaskPromise

Remarks

Privilege

Tip

no-restricted-execution -

Throws

This function can throw errors.

同领域相关