Class BrushShapeManager`Beta`

Index

Properties

activeBrushVolume?

Methods

activateBrushTool beginPainting deactivateBrushTool endPainting getBrushShapeOffset setBrushMask setBrushShape setBrushShapeOffset setBrushShapeVisible setFlattenHeight setFlattenRadius setTerrainStrength singlePaint switchBrushPaintMode

Properties

`Optional` `Readonly` `Beta`activeBrushVolume

activeBrushVolume?: RelativeVolumeListBlockVolume

Methods

activateBrushTool

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

beginPainting

beginPainting(onComplete: (arg0: PaintCompletionState) => void): void
Beta
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void
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:1737

deactivateBrushTool

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

endPainting

endPainting(cancelled: boolean): void
Beta
Parameters
- cancelled: boolean
Returns void
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:1752

getBrushShapeOffset

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

setBrushMask

setBrushMask(mask: BlockMaskList): void
Beta
Parameters
- mask: BlockMaskList
Returns void
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:1767

setBrushShape

setBrushShape(shape: Vector3[] | RelativeVolumeListBlockVolume): void
Beta
Parameters
- shape: Vector3[] | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1773

setBrushShapeOffset

setBrushShapeOffset(offset: Vector3): void
Beta
Parameters
- offset: Vector3
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1779

setBrushShapeVisible

setBrushShapeVisible(visible: boolean): void
Beta
Parameters
- visible: boolean
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1785

setFlattenHeight

setFlattenHeight(flattenHeight: number): void
Beta
Parameters
- flattenHeight: number
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1791

setFlattenRadius

setFlattenRadius(flattenRadius: number): void
Beta
Parameters
- flattenRadius: number
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1797

setTerrainStrength

setTerrainStrength(terrainStrength: number): void
Beta
Parameters
- terrainStrength: number
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1803

singlePaint

singlePaint(onComplete: (arg0: PaintCompletionState) => void): void
Beta
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void
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:1812

switchBrushPaintMode

switchBrushPaintMode(paintMode: PaintMode): void
Beta
Parameters
- paintMode: PaintMode
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1818