Class BlockUtilities

Index

Constructors

Methods

fillVolume findObscuredBlocksWithinVolume getContiguousSelection getDimensionLocationBoundingBox getDimensionMaxLocation getDimensionMinLocation getFacePreviewSelection isLocationInsideCurrentDimensionBounds quickExtrude shrinkWrapVolume trimVolumeToFitContents

Constructors

`Private`constructor

new BlockUtilities(): BlockUtilities
Returns BlockUtilities

Methods

fillVolume

fillVolume(
    volume:
        | BlockVolumeBase
        | CompoundBlockVolume
        | RelativeVolumeListBlockVolume,
    block?: string | BlockPermutation | BlockType,
): void
Parameters
- volume: BlockVolumeBase | CompoundBlockVolume | RelativeVolumeListBlockVolume
- Optionalblock: string | BlockPermutation | BlockType
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

findObscuredBlocksWithinVolume

findObscuredBlocksWithinVolume(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
): RelativeVolumeListBlockVolume
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
Remarks
Write Privilege
This function can't be called in read-only mode.

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

getContiguousSelection

getContiguousSelection(
properties?: ContiguousSelectionProperties,
): CompoundBlockVolume
Parameters
- Optionalproperties: ContiguousSelectionProperties
Returns CompoundBlockVolume
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

getDimensionLocationBoundingBox

getDimensionLocationBoundingBox(): BlockBoundingBox
Returns BlockBoundingBox
Remarks
Write Privilege
This function can't be called in read-only mode.

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

getDimensionMaxLocation

getDimensionMaxLocation(): Vector3
Returns Vector3
Remarks
Write Privilege
This function can't be called in read-only mode.

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

getDimensionMinLocation

getDimensionMinLocation(): Vector3
Returns Vector3
Remarks
Write Privilege
This function can't be called in read-only mode.

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

getFacePreviewSelection

getFacePreviewSelection(properties?: QuickExtrudeProperties): ListBlockVolume
Parameters
- Optionalproperties: QuickExtrudeProperties
Returns ListBlockVolume
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

isLocationInsideCurrentDimensionBounds

isLocationInsideCurrentDimensionBounds(
    locationOrVolumeOrBounds:
        | Vector3
        | BlockBoundingBox
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): boolean
Parameters
- locationOrVolumeOrBounds: Vector3 | BlockBoundingBox | BlockVolumeBase | RelativeVolumeListBlockVolume
Returns boolean
Remarks
Write Privilege
This function can't be called in read-only mode.

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

quickExtrude

quickExtrude(properties?: QuickExtrudeProperties): void
Parameters
- Optionalproperties: QuickExtrudeProperties
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

shrinkWrapVolume

shrinkWrapVolume(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
): RelativeVolumeListBlockVolume
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
Remarks
Write Privilege
This function can't be called in read-only mode.

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,
): RelativeVolumeListBlockVolume
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
- retainMarqueeAfterTrimming: boolean
- ignoreLiquid: boolean
- ignoreNoCollision: boolean
- OptionalblockMask: BlockMaskList
Returns RelativeVolumeListBlockVolume
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

Class BlockUtilities

Index

Constructors

Methods

Constructors

Privateconstructor

Returns BlockUtilities

Methods

fillVolume

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

findObscuredBlocksWithinVolume

Parameters

Returns RelativeVolumeListBlockVolume

Remarks

Write Privilege

World Ready

getContiguousSelection

Parameters

Returns CompoundBlockVolume

Remarks

Write Privilege

Throws

World Ready

getDimensionLocationBoundingBox

Returns BlockBoundingBox

Remarks

Write Privilege

World Ready

getDimensionMaxLocation

Returns Vector3

Remarks

Write Privilege

World Ready

getDimensionMinLocation

Returns Vector3

Remarks

Write Privilege

World Ready

getFacePreviewSelection

Parameters

Returns ListBlockVolume

Remarks

Write Privilege

Throws

World Ready

isLocationInsideCurrentDimensionBounds

Parameters

Returns boolean

Remarks

Write Privilege

World Ready

quickExtrude

Parameters

Returns void

Remarks

Write Privilege

Throws

World Ready

shrinkWrapVolume

Parameters

Returns RelativeVolumeListBlockVolume

Remarks

Write Privilege

World Ready

trimVolumeToFitContents

Parameters

Returns RelativeVolumeListBlockVolume

Remarks

Write Privilege

Throws

World Ready

Settings

On This Page

`Private`constructor