Class BrushShapeManager

Properties

`Optional` `Readonly`activeBrushVolume

activeBrushVolume?: RelativeVolumeListBlockVolume

Methods

activateBrushTool

activateBrushTool(): void
World mutation
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2863

beginPainting

beginPainting(onComplete: (arg0: PaintCompletionState) => void): void
World mutation
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void

Remarks

Throws
- Defined in @minecraft/server-editor.d.ts:2870

clearBlockStateOverrides

clearBlockStateOverrides(): void
World mutation
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2876

deactivateBrushTool

deactivateBrushTool(): void
World mutation
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2882

disableItemPlacement

disableItemPlacement(): void
World mutation
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2888

enableItemPlacement

enableItemPlacement(itemType: ItemType, data?: number): void
World mutation
Parameters
- itemType: ItemType
- Optionaldata: number
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2894

endPainting

endPainting(cancelled: boolean): void
World mutation
Parameters
- cancelled: boolean
Returns void

Remarks

Throws
- Defined in @minecraft/server-editor.d.ts:2901

getBrushShapeOffset

getBrushShapeOffset(): Vector3
World mutation
Returns Vector3

Remarks
- Defined in @minecraft/server-editor.d.ts:2907

getDirectionalPlacementMode

getDirectionalPlacementMode(): BrushDirectionalPlacementMode
World mutation
Returns BrushDirectionalPlacementMode

Remarks
- Defined in @minecraft/server-editor.d.ts:2913

getInverseEraseMode

getInverseEraseMode(): boolean
World mutation
Returns boolean

Remarks
- Defined in @minecraft/server-editor.d.ts:2919

isBrushPaintBusy

isBrushPaintBusy(): boolean
World mutation
Returns boolean

Remarks
- Defined in @minecraft/server-editor.d.ts:2925

pushBlockStateOverride

pushBlockStateOverride<T extends keyof BlockStateSuperset>(
blockStateName: T,
blockStateValue: BlockStateSuperset[T],
): void
World mutation
Type Parameters
- T extends keyof BlockStateSuperset
Parameters
- blockStateName: T
- blockStateValue: BlockStateSuperset[T]
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2931

setBlockFacePlacementBasedOnCamera

setBlockFacePlacementBasedOnCamera(enabled: boolean): void
World mutation
Parameters
- enabled: boolean
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2940

setBrushMask

setBrushMask(mask: BlockMaskList): void
World mutation
Parameters
- mask: BlockMaskList
Returns void

Remarks

Throws
- Defined in @minecraft/server-editor.d.ts:2947

setBrushShape

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

Remarks
- Defined in @minecraft/server-editor.d.ts:2953

setBrushShapeOffset

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

Remarks
- Defined in @minecraft/server-editor.d.ts:2959

setBrushShapeVisible

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

Remarks
- Defined in @minecraft/server-editor.d.ts:2965

setDirectionalPlacementMode

setDirectionalPlacementMode(
directionalPlacementMode: BrushDirectionalPlacementMode,
): void
World mutation
Parameters
- directionalPlacementMode: BrushDirectionalPlacementMode
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2971

setElevationBrushRadius

setElevationBrushRadius(elevationBrushRadius: number): void
World mutation
Parameters
- elevationBrushRadius: number
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2977

setElevationFalloff

setElevationFalloff(elevationFalloff: number): void
World mutation
Parameters
- elevationFalloff: number
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2983

setElevationMode

setElevationMode(elevationMode: BrushElevationMode): void
World mutation
Parameters
- elevationMode: BrushElevationMode
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2989

setElevationSampleLayers

setElevationSampleLayers(elevationSampleLayers: number): void
World mutation
Parameters
- elevationSampleLayers: number
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:2995

setFlattenMode

setFlattenMode(flattenMode: FlattenMode): void
World mutation
Parameters
- flattenMode: FlattenMode
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:3001

setFlattenSmoothing

setFlattenSmoothing(flattenSmoothing: number): void
World mutation
Parameters
- flattenSmoothing: number
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:3007

setFloorBlockOverride

setFloorBlockOverride(floorBlockOverride: boolean): void
World mutation
Parameters
- floorBlockOverride: boolean
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:3013

setInverseEraseMode

setInverseEraseMode(inverseEraseMode: boolean): void
World mutation
Parameters
- inverseEraseMode: boolean
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:3019

setPendingTransaction

setPendingTransaction(pendingTransaction?: PendingTransaction): void
World mutation
Parameters
- OptionalpendingTransaction: PendingTransaction
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:3025

setTerrainStrength

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

Remarks
- Defined in @minecraft/server-editor.d.ts:3031

singlePaint

singlePaint(onComplete: (arg0: PaintCompletionState) => void): void
World mutation
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void

Remarks

Throws
- Defined in @minecraft/server-editor.d.ts:3038

switchBrushPaintMode

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

Remarks
- Defined in @minecraft/server-editor.d.ts:3044