Class BrushShapeManagerBeta

Optional Readonly BetaactiveBrushVolume

activateBrushTool

• activateBrushTool(): void
  Beta

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

beginPainting

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

  Parameters

  • onComplete: (arg0: PaintCompletionState) => void

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

clearBlockStateOverrides

• clearBlockStateOverrides(): void
  Beta

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

deactivateBrushTool

• deactivateBrushTool(): void
  Beta

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

disableItemPlacement

• disableItemPlacement(): void
  Beta

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

enableItemPlacement

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

  Parameters

  • itemType: ItemType
  • Optionaldata: number

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

endPainting

• endPainting(cancelled: boolean): void
  Beta

  Parameters

  • cancelled: boolean

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

getBrushShapeOffset

• getBrushShapeOffset(): Vector3
  Beta

  Returns Vector3

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

getDirectionalPlacementMode

• getDirectionalPlacementMode(): BrushDirectionalPlacementMode
  Beta

  Returns BrushDirectionalPlacementMode

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

getInverseEraseMode

• getInverseEraseMode(): boolean
  Beta

  Returns boolean

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

isBrushPaintBusy

• isBrushPaintBusy(): boolean
  Beta

  Returns boolean

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

pushBlockStateOverride

• pushBlockStateOverride<T extends keyof BlockStateSuperset>(
      blockStateName: T,
      blockStateValue: BlockStateSuperset[T],
  ): void
  Beta

  Type Parameters

  • T extends keyof BlockStateSuperset

  Parameters

  • blockStateName: T
  • blockStateValue: BlockStateSuperset[T]

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setBlockFacePlacementBasedOnCamera

• setBlockFacePlacementBasedOnCamera(enabled: boolean): void
  Beta

  Parameters

  • enabled: boolean

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setBrushMask

• setBrushMask(mask: BlockMaskList): void
  Beta

  Parameters

  • mask: BlockMaskList

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

setBrushShape

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

  Parameters

  • shape: Vector3[] | RelativeVolumeListBlockVolume

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setBrushShapeOffset

• setBrushShapeOffset(offset: Vector3): void
  Beta

  Parameters

  • offset: Vector3

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setBrushShapeVisible

• setBrushShapeVisible(visible: boolean): void
  Beta

  Parameters

  • visible: boolean

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setDirectionalPlacementMode

• setDirectionalPlacementMode(
      directionalPlacementMode: BrushDirectionalPlacementMode,
  ): void
  Beta

  Parameters

  • directionalPlacementMode: BrushDirectionalPlacementMode

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setElevationBrushRadius

• setElevationBrushRadius(elevationBrushRadius: number): void
  Beta

  Parameters

  • elevationBrushRadius: number

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setElevationFalloff

• setElevationFalloff(elevationFalloff: number): void
  Beta

  Parameters

  • elevationFalloff: number

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setElevationMode

• setElevationMode(elevationMode: BrushElevationMode): void
  Beta

  Parameters

  • elevationMode: BrushElevationMode

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setElevationSampleLayers

• setElevationSampleLayers(elevationSampleLayers: number): void
  Beta

  Parameters

  • elevationSampleLayers: number

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setFlattenMode

• setFlattenMode(flattenMode: FlattenMode): void
  Beta

  Parameters

  • flattenMode: FlattenMode

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setFlattenSmoothing

• setFlattenSmoothing(flattenSmoothing: number): void
  Beta

  Parameters

  • flattenSmoothing: number

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setFloorBlockOverride

• setFloorBlockOverride(floorBlockOverride: boolean): void
  Beta

  Parameters

  • floorBlockOverride: boolean

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setInverseEraseMode

• setInverseEraseMode(inverseEraseMode: boolean): void
  Beta

  Parameters

  • inverseEraseMode: boolean

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setPendingTransaction

• setPendingTransaction(pendingTransaction?: PendingTransaction): void
  Beta

  Parameters

  • OptionalpendingTransaction: PendingTransaction

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

setTerrainStrength

• setTerrainStrength(terrainStrength: number): void
  Beta

  Parameters

  • terrainStrength: number

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

singlePaint

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

  Parameters

  • onComplete: (arg0: PaintCompletionState) => void

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

switchBrushPaintMode

• switchBrushPaintMode(paintMode: PaintMode): void
  Beta

  Parameters

  • paintMode: PaintMode

  Returns void

  Remarks

  Privilege

  no-restricted-execution - This function can't be called in restricted-execution mode.