Class BlockUtilities`Beta`

Index

Methods

fillVolume getContiguousSelection getDimensionLocationBoundingBox getDimensionMaxLocation getDimensionMinLocation getFacePreviewSelection isLocationInsideCurrentDimensionBounds quickExtrude shrinkWrapVolume trimVolumeToFitContents

Methods

fillVolume

fillVolume(
    volume:
        | BlockVolumeBase
        | CompoundBlockVolume
        | RelativeVolumeListBlockVolume,
    block?: string | BlockPermutation | BlockType,
): void
Beta
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.
- Defined in tmp/package/index.d.ts:1622

getContiguousSelection

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

Throws
This function can throw errors.

Error
- Defined in tmp/package/index.d.ts:1634

getDimensionLocationBoundingBox

getDimensionLocationBoundingBox(): BlockBoundingBox
Beta
Returns BlockBoundingBox
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1640

getDimensionMaxLocation

getDimensionMaxLocation(): Vector3
Beta
Returns Vector3
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1646

getDimensionMinLocation

getDimensionMinLocation(): Vector3
Beta
Returns Vector3
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1652

getFacePreviewSelection

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

Throws
This function can throw errors.

Error
- Defined in tmp/package/index.d.ts:1661

isLocationInsideCurrentDimensionBounds

isLocationInsideCurrentDimensionBounds(
    locationOrVolumeOrBounds:
        | Vector3
        | BlockBoundingBox
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): boolean
Beta
Parameters
- locationOrVolumeOrBounds: Vector3 | BlockBoundingBox | BlockVolumeBase | RelativeVolumeListBlockVolume
Returns boolean
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1667

quickExtrude

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

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:1680

shrinkWrapVolume

shrinkWrapVolume(
volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
): RelativeVolumeListBlockVolume
Beta
Parameters
- volume: BlockVolumeBase | RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1686

trimVolumeToFitContents

trimVolumeToFitContents(
    volume: BlockVolumeBase | RelativeVolumeListBlockVolume,
    retainMarqueeAfterTrimming: boolean,
    ignoreLiquid: boolean,
    ignoreNoCollision: boolean,
    blockMask?: BlockMaskList,
): RelativeVolumeListBlockVolume
Beta
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.

Error
- Defined in tmp/package/index.d.ts:1697

Class BlockUtilitiesBeta

Index

Methods

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

Class BlockUtilities`Beta`