#Class: BrushShapeManager experimental

Beta

#Properties

#activeBrushVolume?

readonly optional activeBrushVolume?: RelativeVolumeListBlockVolume

Beta

#Methods

#activateBrushTool()

activateBrushTool(): void

World Mutation Beta

#Returns

void

#Remarks

---

#beginPainting()

beginPainting(onComplete): void

World Mutation Beta

#Parameters

#onComplete

(arg0) => void

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#clearBlockStateOverrides()

clearBlockStateOverrides(): void

World Mutation Beta

#Returns

void

#Remarks

---

#deactivateBrushTool()

deactivateBrushTool(): void

World Mutation Beta

#Returns

void

#Remarks

---

#disableItemPlacement()

disableItemPlacement(): void

World Mutation Beta

#Returns

void

#Remarks

---

#enableItemPlacement()

enableItemPlacement(itemType, data?): void

World Mutation Beta

#Parameters

#itemType

ItemType

#data?

number

#Returns

void

#Remarks

---

#endPainting()

endPainting(cancelled): void

World Mutation Beta

#Parameters

#cancelled

boolean

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#getBrushShapeOffset()

getBrushShapeOffset(): Vector3

World Mutation Beta

#Returns

Vector3

#Remarks

---

#getDirectionalPlacementMode()

getDirectionalPlacementMode(): BrushDirectionalPlacementMode

World Mutation Beta

#Returns

BrushDirectionalPlacementMode

#Remarks

---

#getInverseEraseMode()

getInverseEraseMode(): boolean

World Mutation Beta

#Returns

boolean

#Remarks

---

#isBrushPaintBusy()

isBrushPaintBusy(): boolean

World Mutation Beta

#Returns

boolean

#Remarks

---

#pushBlockStateOverride()

pushBlockStateOverride<T>(blockStateName, blockStateValue): void

World Mutation Beta

#Type Parameters

#T

T extends string | number | symbol

#Parameters

#blockStateName

T

#blockStateValue

BlockStateSuperset

#Returns

void

#Remarks

---

#setBlockFacePlacementBasedOnCamera()

setBlockFacePlacementBasedOnCamera(enabled): void

World Mutation Beta

#Parameters

#enabled

boolean

#Returns

void

#Remarks

---

#setBrushMask()

setBrushMask(mask): void

World Mutation Beta

#Parameters

#mask

BlockMaskList

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#setBrushShape()

setBrushShape(shape): void

World Mutation Beta

#Parameters

#shape

RelativeVolumeListBlockVolume | Vector3[]

#Returns

void

#Remarks

---

#setBrushShapeOffset()

setBrushShapeOffset(offset): void

World Mutation Beta

#Parameters

#offset

Vector3

#Returns

void

#Remarks

---

#setBrushShapeVisible()

setBrushShapeVisible(visible): void

World Mutation Beta

#Parameters

#visible

boolean

#Returns

void

#Remarks

---

#setDirectionalPlacementMode()

setDirectionalPlacementMode(directionalPlacementMode): void

World Mutation Beta

#Parameters

#directionalPlacementMode

BrushDirectionalPlacementMode

#Returns

void

#Remarks

---

#setElevationBrushRadius()

setElevationBrushRadius(elevationBrushRadius): void

World Mutation Beta

#Parameters

#elevationBrushRadius

number

#Returns

void

#Remarks

---

#setElevationFalloff()

setElevationFalloff(elevationFalloff): void

World Mutation Beta

#Parameters

#elevationFalloff

number

#Returns

void

#Remarks

---

#setElevationMode()

setElevationMode(elevationMode): void

World Mutation Beta

#Parameters

#elevationMode

BrushElevationMode

#Returns

void

#Remarks

---

#setElevationSampleLayers()

setElevationSampleLayers(elevationSampleLayers): void

World Mutation Beta

#Parameters

#elevationSampleLayers

number

#Returns

void

#Remarks

---

#setFlattenMode()

setFlattenMode(flattenMode): void

World Mutation Beta

#Parameters

#flattenMode

FlattenMode

#Returns

void

#Remarks

---

#setFlattenSmoothing()

setFlattenSmoothing(flattenSmoothing): void

World Mutation Beta

#Parameters

#flattenSmoothing

number

#Returns

void

#Remarks

---

#setFloorBlockOverride()

setFloorBlockOverride(floorBlockOverride): void

World Mutation Beta

#Parameters

#floorBlockOverride

boolean

#Returns

void

#Remarks

---

#setInverseEraseMode()

setInverseEraseMode(inverseEraseMode): void

World Mutation Beta

#Parameters

#inverseEraseMode

boolean

#Returns

void

#Remarks

---

#setPendingTransaction()

setPendingTransaction(pendingTransaction?): void

World Mutation Beta

#Parameters

#pendingTransaction?

PendingTransaction

#Returns

void

#Remarks

---

#setTerrainStrength()

setTerrainStrength(terrainStrength): void

World Mutation Beta

#Parameters

#terrainStrength

number

#Returns

void

#Remarks

---

#singlePaint()

singlePaint(onComplete): void

World Mutation Beta

#Parameters

#onComplete

(arg0) => void

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#switchBrushPaintMode()

switchBrushPaintMode(paintMode): void

World Mutation Beta

#Parameters

#paintMode

PaintMode

#Returns

void

#Remarks