Class BlockUtilities`Beta`

Index

Methods

fillVolume getContiguousSelection getFacePreviewSelection getMaxWorldLocation getMinWorldLocation isLocationInWorld 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

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:1643

getMaxWorldLocation

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

getMinWorldLocation

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

isLocationInWorld

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

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:1674

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:1680

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:1691

Class BlockUtilitiesBeta

Index

Methods

Methods

fillVolume

Parameters

Returns void

Remarks

Throws

getContiguousSelection

Parameters

Returns CompoundBlockVolume

Remarks

Throws

getFacePreviewSelection

Parameters

Returns ListBlockVolume

Remarks

Throws

getMaxWorldLocation

Returns Vector3

Remarks

getMinWorldLocation

Returns Vector3

Remarks

isLocationInWorld

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`