Class BlockUtilityTasks

Index

Constructors

Methods

extrude fillVolume findObscuredBlocksWithinVolume floodSearch generateManifest replaceBlocksInSelection shrinkWrapVolume trimVolumeToFitContents

Constructors

`Private`constructor

new BlockUtilityTasks(): BlockUtilityTasks
Returns BlockUtilityTasks

Methods

extrude

extrude(
    location: Vector3,
    direction?: BlockUtilityExtrudeDirection,
    faceRadius?: number,
    layerCount?: number,
    isShrink?: boolean,
    criteria?: BlockUtilityFloodMatchCriteria,
    customBlockList?: string[],
    maxBlocksPerTick?: number,
    buildGeometry?: boolean,
    tolerance?: number,
    faceVolume?: BlockVolumeBase | RelativeVolumeListBlockVolume,
): VolumeTaskPromise
Parameters
- location: Vector3
- Optionaldirection: BlockUtilityExtrudeDirection
- OptionalfaceRadius: number
- OptionallayerCount: number
- OptionalisShrink: boolean
- Optionalcriteria: BlockUtilityFloodMatchCriteria
- OptionalcustomBlockList: string[]
- OptionalmaxBlocksPerTick: number
- OptionalbuildGeometry: boolean
- Optionaltolerance: number
- OptionalfaceVolume: BlockVolumeBase | RelativeVolumeListBlockVolume
Returns VolumeTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

fillVolume

fillVolume(
    volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
    block?: string | BlockPermutation | BlockType,
    maxBlocksPerTick?: number,
): NumberTaskPromise
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- Optionalblock: string | BlockPermutation | BlockType
- OptionalmaxBlocksPerTick: number
Returns NumberTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

findObscuredBlocksWithinVolume

findObscuredBlocksWithinVolume(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
maxBlocksPerTick?: number,
): VolumeTaskPromise
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- OptionalmaxBlocksPerTick: number
Returns VolumeTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

floodSearch

floodSearch(
    location: Vector3,
    criteria?: BlockUtilityFloodMatchCriteria,
    radius?: number,
    customBlockList?: string[],
    maxResultBlocks?: number,
    maxBlocksPerTick?: number,
    directionMask?: number,
): VolumeTaskPromise
Parameters
- location: Vector3
- Optionalcriteria: BlockUtilityFloodMatchCriteria
- Optionalradius: number
- OptionalcustomBlockList: string[]
- OptionalmaxResultBlocks: number
- OptionalmaxBlocksPerTick: number
- OptionaldirectionMask: number
Returns VolumeTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

generateManifest

generateManifest(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
maxBlocksPerTick?: number,
): ManifestTaskPromise
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- OptionalmaxBlocksPerTick: number
Returns ManifestTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

replaceBlocksInSelection

replaceBlocksInSelection(
    volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
    fromBlockIdentifier: string,
    toBlock?: string | BlockPermutation | BlockType,
    maxBlocksPerTick?: number,
): NumberTaskPromise
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- fromBlockIdentifier: string
- OptionaltoBlock: string | BlockPermutation | BlockType
- OptionalmaxBlocksPerTick: number
Returns NumberTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

shrinkWrapVolume

shrinkWrapVolume(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
maxBlocksPerTick?: number,
): VolumeTaskPromise
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- OptionalmaxBlocksPerTick: number
Returns VolumeTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

trimVolumeToFitContents

trimVolumeToFitContents(
    volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
    retainMarqueeAfterTrimming: boolean,
    ignoreLiquid: boolean,
    ignoreNoCollision: boolean,
    blockMask?: BlockMaskList,
    maxBlocksPerTick?: number,
): VolumeTaskPromise
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- retainMarqueeAfterTrimming: boolean
- ignoreLiquid: boolean
- ignoreNoCollision: boolean
- OptionalblockMask: BlockMaskList
- OptionalmaxBlocksPerTick: number
Returns VolumeTaskPromise
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

Class BlockUtilityTasks

Index

Constructors

Methods

Constructors

Privateconstructor

Returns BlockUtilityTasks

Methods

extrude

Parameters

Returns VolumeTaskPromise

Remarks

Privilege

Throws

World Ready

fillVolume

Parameters

Returns NumberTaskPromise

Remarks

Privilege

Throws

World Ready

findObscuredBlocksWithinVolume

Parameters

Returns VolumeTaskPromise

Remarks

Privilege

Throws

World Ready

floodSearch

Parameters

Returns VolumeTaskPromise

Remarks

Privilege

Throws

World Ready

generateManifest

Parameters

Returns ManifestTaskPromise

Remarks

Privilege

Throws

World Ready

replaceBlocksInSelection

Parameters

Returns NumberTaskPromise

Remarks

Privilege

Throws

World Ready

shrinkWrapVolume

Parameters

Returns VolumeTaskPromise

Remarks

Privilege

Throws

World Ready

trimVolumeToFitContents

Parameters

Returns VolumeTaskPromise

Remarks

Privilege

Throws

World Ready

Settings

On This Page

`Private`constructor