Class BrushShapeManager

Constructors

`Private`constructor

new BrushShapeManager(): BrushShapeManager
Returns BrushShapeManager

Properties

`Optional` `Readonly`activeBrushVolume

activeBrushVolume?: RelativeVolumeListBlockVolume

Methods

activateBrushTool

activateBrushTool(): void
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

beginPainting

beginPainting(onComplete: (arg0: PaintCompletionState) => void): void
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

clearBlockStateOverrides

clearBlockStateOverrides(): void
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

deactivateBrushTool

deactivateBrushTool(): void
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

disableItemPlacement

disableItemPlacement(): void
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

enableItemPlacement

enableItemPlacement(itemType: ItemType, data?: number): void
Parameters
- itemType: ItemType
- Optionaldata: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

endPainting

endPainting(cancelled: boolean): void
Parameters
- cancelled: boolean
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

getBrushShapeOffset

getBrushShapeOffset(): Vector3
Returns Vector3
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

getDirectionalPlacementMode

getDirectionalPlacementMode(): BrushDirectionalPlacementMode
Returns BrushDirectionalPlacementMode
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

getInverseEraseMode

getInverseEraseMode(): boolean
Returns boolean
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

isBrushPaintBusy

isBrushPaintBusy(): boolean
Returns boolean
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

pushBlockStateOverride

pushBlockStateOverride<T extends string | number | symbol>(
blockStateName: T,
blockStateValue: BlockStateSuperset,
): void
Type Parameters
- T extends string | number | symbol
Parameters
- blockStateName: T
- blockStateValue: BlockStateSuperset
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setBlockFacePlacementBasedOnCamera

setBlockFacePlacementBasedOnCamera(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setBrushMask

setBrushMask(mask: BlockMaskList): void
Parameters
- mask: BlockMaskList
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

setBrushShape

setBrushShape(shape: Vector3[] | RelativeVolumeListBlockVolume): void
Parameters
- shape: Vector3[] | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setBrushShapeOffset

setBrushShapeOffset(offset: Vector3): void
Parameters
- offset: Vector3
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setBrushShapeVisible

setBrushShapeVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setDirectionalPlacementMode

setDirectionalPlacementMode(
directionalPlacementMode: BrushDirectionalPlacementMode,
): void
Parameters
- directionalPlacementMode: BrushDirectionalPlacementMode
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setElevationBrushRadius

setElevationBrushRadius(elevationBrushRadius: number): void
Parameters
- elevationBrushRadius: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setElevationFalloff

setElevationFalloff(elevationFalloff: number): void
Parameters
- elevationFalloff: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setElevationMode

setElevationMode(elevationMode: BrushElevationMode): void
Parameters
- elevationMode: BrushElevationMode
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setElevationSampleLayers

setElevationSampleLayers(elevationSampleLayers: number): void
Parameters
- elevationSampleLayers: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setFlattenMode

setFlattenMode(flattenMode: FlattenMode): void
Parameters
- flattenMode: FlattenMode
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setFlattenSmoothing

setFlattenSmoothing(flattenSmoothing: number): void
Parameters
- flattenSmoothing: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setFloorBlockOverride

setFloorBlockOverride(floorBlockOverride: boolean): void
Parameters
- floorBlockOverride: boolean
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setInverseEraseMode

setInverseEraseMode(inverseEraseMode: boolean): void
Parameters
- inverseEraseMode: boolean
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

setTerrainStrength

setTerrainStrength(terrainStrength: number): void
Parameters
- terrainStrength: number
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.

singlePaint

singlePaint(onComplete: (arg0: PaintCompletionState) => void): void
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void
Remarks
This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

World Ready
This function can't be called in early-execution mode.

switchBrushPaintMode

switchBrushPaintMode(paintMode: PaintMode): void
Parameters
- paintMode: PaintMode
Returns void
Remarks
This function can't be called in restricted-execution mode.

World Ready
This function can't be called in early-execution mode.