#Class: BlockUtilityTasks experimental

block

Beta

#Methods

#extrude()

extrude(location, direction?, faceRadius?, layerCount?, isShrink?, criteria?, customBlockList?, maxBlocksPerTick?, buildGeometry?, tolerance?, faceVolume?): Promise<RelativeVolumeListBlockVolume>

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

Promise<RelativeVolumeListBlockVolume>

#Remarks

#Throws

This function can throw errors.

---

#fillVolume()

fillVolume(volume, block?, maxBlocksPerTick?): Promise<number>

World Mutation Beta

#Parameters

#volume

any

#block?

any

#maxBlocksPerTick?

number

#Returns

Promise<number>

#Remarks

#Throws

This function can throw errors.

---

#findObscuredBlocksWithinVolume()

findObscuredBlocksWithinVolume(volume, maxBlocksPerTick?): Promise<RelativeVolumeListBlockVolume>

World Mutation Beta

#Parameters

#volume

any

#maxBlocksPerTick?

number

#Returns

Promise<RelativeVolumeListBlockVolume>

#Remarks

#Throws

This function can throw errors.

---

#floodSearch()

floodSearch(location, criteria?, radius?, customBlockList?, maxResultBlocks?, maxBlocksPerTick?): Promise<RelativeVolumeListBlockVolume>

World Mutation Beta

#Parameters

#location

Vector3

#criteria?

BlockUtilityFloodMatchCriteria

#radius?

number

#customBlockList?

string[]

#maxResultBlocks?

number

#maxBlocksPerTick?

number

#Returns

Promise<RelativeVolumeListBlockVolume>

#Remarks

#Throws

This function can throw errors.

---

#generateManifest()

generateManifest(volume, maxBlocksPerTick?): Promise<BlockUtilityManifest>

World Mutation Beta

#Parameters

#volume

any

#maxBlocksPerTick?

number

#Returns

Promise<BlockUtilityManifest>

#Remarks

#Throws

This function can throw errors.

---

#replaceBlocksInSelection()

replaceBlocksInSelection(volume, fromBlockIdentifier, toBlock?, maxBlocksPerTick?): Promise<number>

World Mutation Beta

#Parameters

#volume

any

#fromBlockIdentifier

string

#toBlock?

any

#maxBlocksPerTick?

number

#Returns

Promise<number>

#Remarks

#Throws

This function can throw errors.

---

#shrinkWrapVolume()

shrinkWrapVolume(volume, maxBlocksPerTick?): Promise<RelativeVolumeListBlockVolume>

World Mutation Beta

#Parameters

#volume

any

#maxBlocksPerTick?

number

#Returns

Promise<RelativeVolumeListBlockVolume>

#Remarks

#Throws

This function can throw errors.

---

#trimVolumeToFitContents()

trimVolumeToFitContents(volume, retainMarqueeAfterTrimming, ignoreLiquid, ignoreNoCollision, blockMask?, maxBlocksPerTick?): Promise<RelativeVolumeListBlockVolume>

World Mutation Beta

#Parameters

#volume

any

#retainMarqueeAfterTrimming

boolean

#ignoreLiquid

boolean

#ignoreNoCollision

boolean

#blockMask?

BlockMaskList

#maxBlocksPerTick?

number

#Returns

Promise<RelativeVolumeListBlockVolume>

#Remarks

#Throws

This function can throw errors.

#同领域相关

• BlockIdentifierListObservableValidator
• BlockIdentifierObservableValidator
• BlockMaskList
• BlockMaskListType
• BlockPalette
• BlockPaletteItemType