Class BlockUtilities

Index

Constructors

Methods

fillVolume 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
This function can't be called in read-only mode.

Throws
This function can throw errors.

getContiguousSelection

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

Throws
This function can throw errors.

getDimensionLocationBoundingBox

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

getDimensionMaxLocation

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

getDimensionMinLocation

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

getFacePreviewSelection

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

Throws
This function can throw errors.

isLocationInsideCurrentDimensionBounds

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

quickExtrude

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

Throws
This function can throw errors.

shrinkWrapVolume

shrinkWrapVolume(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
): RelativeVolumeListBlockVolume
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
Remarks
This function can't be called in read-only 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
This function can't be called in read-only mode.

Throws
This function can throw errors.

Class BlockUtilities

Index

Constructors

Methods

Constructors

Privateconstructor

Returns BlockUtilities

Methods

fillVolume

Parameters

Returns void

Remarks

Throws

getContiguousSelection

Parameters

Returns CompoundBlockVolume

Remarks

Throws

getDimensionLocationBoundingBox

Returns BlockBoundingBox

Remarks

getDimensionMaxLocation

Returns Vector3

Remarks

getDimensionMinLocation

Returns Vector3

Remarks

getFacePreviewSelection

Parameters

Returns ListBlockVolume

Remarks

Throws

isLocationInsideCurrentDimensionBounds

Parameters

Returns boolean

Remarks

quickExtrude

Parameters

Returns void

Remarks

Throws

shrinkWrapVolume

Parameters

Returns RelativeVolumeListBlockVolume

Remarks

trimVolumeToFitContents

Parameters

Returns RelativeVolumeListBlockVolume

Remarks

Throws

Settings

On This Page

`Private`constructor