Class BrushShape`Abstract`

Base for creating new brush shapes

Hierarchy (View Summary)

BrushShape

Index

Constructors

Accessors

displayName icon id

Methods

applySetting calculateBounds createSettingsPane createShape createShapeAsync estimateBlockCount getSettings

Constructors

constructor

new BrushShape(_id: string, _displayName: string, _icon: string): BrushShape
Parameters
- _id: string
- _displayName: string
- _icon: string
Returns BrushShape
Remarks
Constructs a new instance of the BrushShape class
- Defined in @minecraft/server-editor.d.ts:2317

Accessors

displayName

get displayName(): string
Returns string
- Defined in @minecraft/server-editor.d.ts:2309

icon

get icon(): string
Returns string
- Defined in @minecraft/server-editor.d.ts:2310

id

get id(): string
Returns string
- Defined in @minecraft/server-editor.d.ts:2311

Methods

`Abstract`applySetting

applySetting(brushSettings: BrushShapeSettings): void
Parameters
- brushSettings: BrushShapeSettings
Returns void
- Defined in @minecraft/server-editor.d.ts:2318

`Abstract`calculateBounds

calculateBounds(): BlockBoundingBox
Returns BlockBoundingBox
Object with min and max Vector3 bounds

Remarks
Calculates the bounding box of the shape in local coordinates. Used for region allocation before shape placement.
- Defined in @minecraft/server-editor.d.ts:2328

`Abstract`createSettingsPane

createSettingsPane(
    parentPane: IPropertyPane,
    onSettingsChange?: () => void,
    flatLayout?: boolean,
): ISubPanePropertyItem
Parameters
- parentPane: IPropertyPane
- OptionalonSettingsChange: () => void
- OptionalflatLayout: boolean
Returns ISubPanePropertyItem
- Defined in @minecraft/server-editor.d.ts:2329

`Abstract`createShape

createShape(): RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
- Defined in @minecraft/server-editor.d.ts:2334

`Abstract`createShapeAsync

createShapeAsync(
cancelToken?: { cancelled: boolean },
yieldInterval?: number,
): Promise<RelativeVolumeListBlockVolume>
Parameters
- OptionalcancelToken: { cancelled: boolean }
  Optional token to cancel the operation. Set cancelled to true to abort.
- OptionalyieldInterval: number
  Number of blocks to process before yielding. Default is 10000.
Returns Promise<RelativeVolumeListBlockVolume>
Promise that resolves to the shape positions as Vector3 array.

Remarks
Asynchronously creates the shape, yielding control periodically to avoid timeouts. Use this for large shapes where createShape() may timeout.
- Defined in @minecraft/server-editor.d.ts:2351

`Abstract`estimateBlockCount

estimateBlockCount(): number
Returns number
Estimated block count

Remarks
Returns a mathematical estimate of the number of blocks in the shape. Used for UI display and validation before shape creation.
- Defined in @minecraft/server-editor.d.ts:2366

`Abstract`getSettings

getSettings(): BrushShapeSettings
Returns BrushShapeSettings
- Defined in @minecraft/server-editor.d.ts:2367