Class BrushShapeManager

Hierarchy

BrushShapeManager

Index

Constructors

Properties

activeBrushVolume?

Methods

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

Constructors

`Private` constructor

new BrushShapeManager(): BrushShapeManager
Returns BrushShapeManager
- Defined in tmp/package/index.d.ts:1673

Properties

`Optional` `Readonly` activeBrushVolume

activeBrushVolume?: RelativeVolumeListBlockVolume

Methods

activateBrushTool

activateBrushTool(): void
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1680

beginPainting

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

deactivateBrushTool

deactivateBrushTool(): void
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1695

endPainting

endPainting(cancelled): void
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:1704

getBrushShapeOffset

getBrushShapeOffset(): Vector3
Returns Vector3

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1710

setBrushMask

setBrushMask(mask): void
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:1719

setBrushShape

setBrushShape(shape): void
Parameters
- shape: Vector3[] | RelativeVolumeListBlockVolume
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1725

setBrushShapeOffset

setBrushShapeOffset(offset): void
Parameters
- offset: Vector3
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1731

setBrushShapeVisible

setBrushShapeVisible(visible): void
Parameters
- visible: boolean
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1737

setFlattenHeight

setFlattenHeight(flattenHeight): void
Parameters
- flattenHeight: number
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1743

setFlattenRadius

setFlattenRadius(flattenRadius): void
Parameters
- flattenRadius: number
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1749

setTerrainStrength

setTerrainStrength(terrainStrength): void
Parameters
- terrainStrength: number
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1755

singlePaint

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

switchBrushPaintMode

switchBrushPaintMode(paintMode): void
Parameters
- paintMode: PaintMode
Returns void

Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:1770