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

Accessors

displayName

get displayName(): string
Returns string

icon

get icon(): string
Returns string

id

get id(): string
Returns string

Methods

`Abstract`applySetting

applySetting(brushSettings: BrushShapeSettings): void
Parameters
- brushSettings: BrushShapeSettings
Returns void

`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.

World Ready
This function can't be called in early-execution mode.

`Abstract`createSettingsPane

createSettingsPane(
parentPane: IPropertyPane,
onSettingsChange?: () => void,
): ISubPanePropertyItem
Parameters
- parentPane: IPropertyPane
- OptionalonSettingsChange: () => void
Returns ISubPanePropertyItem

`Abstract`createShape

createShape(): RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume

`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.

World Ready
This function can't be called in early-execution mode.

`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.

World Ready
This function can't be called in early-execution mode.

`Abstract`getSettings

getSettings(): BrushShapeSettings
Returns BrushShapeSettings