Class BrushShapeManager

Optional ReadonlyactiveBrushVolume

activateBrushTool

• activateBrushTool(): void

  Returns void

  Remarks

  This function can't be called in read-only mode.

beginPainting

• beginPainting(onComplete: (arg0: PaintCompletionState) => void): void

  Parameters

  • onComplete: (arg0: PaintCompletionState) => void

  Returns void

  Remarks

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

clearBlockStateOverrides

• clearBlockStateOverrides(): void

  Returns void

  Remarks

  This function can't be called in read-only mode.

deactivateBrushTool

• deactivateBrushTool(): void

  Returns void

  Remarks

  This function can't be called in read-only mode.

disableItemPlacement

• disableItemPlacement(): void

  Returns void

  Remarks

  This function can't be called in read-only mode.

enableItemPlacement

• enableItemPlacement(itemType: ItemType, data?: number): void

  Parameters

  • itemType: ItemType
  • Optionaldata: number

  Returns void

  Remarks

  This function can't be called in read-only mode.

endPainting

• endPainting(cancelled: boolean): void

  Parameters

  • cancelled: boolean

  Returns void

  Remarks

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

getBrushShapeOffset

• getBrushShapeOffset(): Vector3

  Returns Vector3

  Remarks

  This function can't be called in read-only mode.

getDirectionalPlacementMode

• getDirectionalPlacementMode(): BrushDirectionalPlacementMode

  Returns BrushDirectionalPlacementMode

  Remarks

  This function can't be called in read-only mode.

getInverseEraseMode

• getInverseEraseMode(): boolean

  Returns boolean

  Remarks

  This function can't be called in read-only mode.

isBrushPaintBusy

• isBrushPaintBusy(): boolean

  Returns boolean

  Remarks

  This function can't be called in read-only 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 read-only mode.

setBlockFacePlacementBasedOnCamera

• setBlockFacePlacementBasedOnCamera(enabled: boolean): void

  Parameters

  • enabled: boolean

  Returns void

  Remarks

  This function can't be called in read-only mode.

setBrushMask

• setBrushMask(mask: BlockMaskList): void

  Parameters

  • mask: BlockMaskList

  Returns void

  Remarks

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

setBrushShape

• setBrushShape(shape: Vector3[] | RelativeVolumeListBlockVolume): void

  Parameters

  • shape: Vector3[] | RelativeVolumeListBlockVolume

  Returns void

  Remarks

  This function can't be called in read-only mode.

setBrushShapeOffset

• setBrushShapeOffset(offset: Vector3): void

  Parameters

  • offset: Vector3

  Returns void

  Remarks

  This function can't be called in read-only mode.

setBrushShapeVisible

• setBrushShapeVisible(visible: boolean): void

  Parameters

  • visible: boolean

  Returns void

  Remarks

  This function can't be called in read-only mode.

setDirectionalPlacementMode

• setDirectionalPlacementMode(
      directionalPlacementMode: BrushDirectionalPlacementMode,
  ): void

  Parameters

  • directionalPlacementMode: BrushDirectionalPlacementMode

  Returns void

  Remarks

  This function can't be called in read-only mode.

setFlattenMode

• setFlattenMode(flattenMode: FlattenMode): void

  Parameters

  • flattenMode: FlattenMode

  Returns void

  Remarks

  This function can't be called in read-only mode.

setFlattenSmoothing

• setFlattenSmoothing(flattenSmoothing: number): void

  Parameters

  • flattenSmoothing: number

  Returns void

  Remarks

  This function can't be called in read-only mode.

setFloorBlockOverride

• setFloorBlockOverride(floorBlockOverride: boolean): void

  Parameters

  • floorBlockOverride: boolean

  Returns void

  Remarks

  This function can't be called in read-only mode.

setInverseEraseMode

• setInverseEraseMode(inverseEraseMode: boolean): void

  Parameters

  • inverseEraseMode: boolean

  Returns void

  Remarks

  This function can't be called in read-only mode.

setTerrainStrength

• setTerrainStrength(terrainStrength: number): void

  Parameters

  • terrainStrength: number

  Returns void

  Remarks

  This function can't be called in read-only mode.

singlePaint

• singlePaint(onComplete: (arg0: PaintCompletionState) => void): void

  Parameters

  • onComplete: (arg0: PaintCompletionState) => void

  Returns void

  Remarks

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

switchBrushPaintMode

• switchBrushPaintMode(paintMode: PaintMode): void

  Parameters

  • paintMode: PaintMode

  Returns void

  Remarks

  This function can't be called in read-only mode.