Class BrushShapeManager

Properties

`Optional` `Readonly`activeBrushVolume

activeBrushVolume?: RelativeVolumeListBlockVolume

Methods

activateBrushTool

activateBrushTool(): void
World mutation
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2155

beginPainting

beginPainting(onComplete: (arg0: PaintCompletionState) => void): void
World mutation
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void
Remarks
Throws
This function can throw errors.
- Defined in @minecraft/server-editor.d.ts:2162

clearBlockStateOverrides

clearBlockStateOverrides(): void
World mutation
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2168

deactivateBrushTool

deactivateBrushTool(): void
World mutation
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2174

disableItemPlacement

disableItemPlacement(): void
World mutation
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2180

enableItemPlacement

enableItemPlacement(itemType: ItemType, data?: number): void
World mutation
Parameters
- itemType: ItemType
- Optionaldata: number
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2186

endPainting

endPainting(cancelled: boolean): void
World mutation
Parameters
- cancelled: boolean
Returns void
Remarks
Throws
This function can throw errors.
- Defined in @minecraft/server-editor.d.ts:2193

getBrushShapeOffset

getBrushShapeOffset(): Vector3
World mutation
Returns Vector3
Remarks
- Defined in @minecraft/server-editor.d.ts:2199

getDirectionalPlacementMode

getDirectionalPlacementMode(): BrushDirectionalPlacementMode
World mutation
Returns BrushDirectionalPlacementMode
Remarks
- Defined in @minecraft/server-editor.d.ts:2205

getInverseEraseMode

getInverseEraseMode(): boolean
World mutation
Returns boolean
Remarks
- Defined in @minecraft/server-editor.d.ts:2211

isBrushPaintBusy

isBrushPaintBusy(): boolean
World mutation
Returns boolean
Remarks
- Defined in @minecraft/server-editor.d.ts:2217

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:2223

setBlockFacePlacementBasedOnCamera

setBlockFacePlacementBasedOnCamera(enabled: boolean): void
World mutation
Parameters
- enabled: boolean
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2232

setBrushMask

setBrushMask(mask: BlockMaskList): void
World mutation
Parameters
- mask: BlockMaskList
Returns void
Remarks
Throws
This function can throw errors.
- Defined in @minecraft/server-editor.d.ts:2239

setBrushShape

setBrushShape(shape: Vector3[] | RelativeVolumeListBlockVolume): void
World mutation
Parameters
- shape: Vector3[] | RelativeVolumeListBlockVolume
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2245

setBrushShapeOffset

setBrushShapeOffset(offset: Vector3): void
World mutation
Parameters
- offset: Vector3
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2251

setBrushShapeVisible

setBrushShapeVisible(visible: boolean): void
World mutation
Parameters
- visible: boolean
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2257

setDirectionalPlacementMode

setDirectionalPlacementMode(
directionalPlacementMode: BrushDirectionalPlacementMode,
): void
World mutation
Parameters
- directionalPlacementMode: BrushDirectionalPlacementMode
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2263

setElevationBrushRadius

setElevationBrushRadius(elevationBrushRadius: number): void
World mutation
Parameters
- elevationBrushRadius: number
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2269

setElevationFalloff

setElevationFalloff(elevationFalloff: number): void
World mutation
Parameters
- elevationFalloff: number
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2275

setElevationMode

setElevationMode(elevationMode: BrushElevationMode): void
World mutation
Parameters
- elevationMode: BrushElevationMode
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2281

setElevationSampleLayers

setElevationSampleLayers(elevationSampleLayers: number): void
World mutation
Parameters
- elevationSampleLayers: number
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2287

setFlattenMode

setFlattenMode(flattenMode: FlattenMode): void
World mutation
Parameters
- flattenMode: FlattenMode
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2293

setFlattenSmoothing

setFlattenSmoothing(flattenSmoothing: number): void
World mutation
Parameters
- flattenSmoothing: number
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2299

setFloorBlockOverride

setFloorBlockOverride(floorBlockOverride: boolean): void
World mutation
Parameters
- floorBlockOverride: boolean
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2305

setInverseEraseMode

setInverseEraseMode(inverseEraseMode: boolean): void
World mutation
Parameters
- inverseEraseMode: boolean
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2311

setTerrainStrength

setTerrainStrength(terrainStrength: number): void
World mutation
Parameters
- terrainStrength: number
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2317

singlePaint

singlePaint(onComplete: (arg0: PaintCompletionState) => void): void
World mutation
Parameters
- onComplete: (arg0: PaintCompletionState) => void
Returns void
Remarks
Throws
This function can throw errors.
- Defined in @minecraft/server-editor.d.ts:2324

switchBrushPaintMode

switchBrushPaintMode(paintMode: PaintMode): void
World mutation
Parameters
- paintMode: PaintMode
Returns void
Remarks
- Defined in @minecraft/server-editor.d.ts:2330