Class SingleBlockBrushShape

Base for creating new brush shapes

Hierarchy (View Summary)

BrushShape
- SingleBlockBrushShape

Index

Constructors

Accessors

displayName icon id

Methods

applySetting calculateBounds createSettingsPane createShape createShapeAsync estimateBlockCount getSettings

Constructors

constructor

new SingleBlockBrushShape(): SingleBlockBrushShape
Returns SingleBlockBrushShape
Remarks
Constructs a new instance of the SingleBlockBrushShape class

Overrides BrushShape.constructor

Accessors

displayName

get displayName(): string
Returns string
Inherited from BrushShape.displayName

icon

get icon(): string
Returns string
Inherited from BrushShape.icon

id

get id(): string
Returns string
Inherited from BrushShape.id

Methods

applySetting

applySetting(_settings: BrushShapeSettings): void
Parameters
- _settings: BrushShapeSettings
Returns void
Overrides BrushShape.applySetting

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.

Overrides BrushShape.calculateBounds

createSettingsPane

createSettingsPane(): undefined
Returns undefined
Overrides BrushShape.createSettingsPane

createShape

createShape(): RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
Overrides BrushShape.createShape

createShapeAsync

createShapeAsync(
_cancelToken?: { cancelled: boolean },
_yieldInterval?: number,
): Promise<RelativeVolumeListBlockVolume>
Parameters
- Optional_cancelToken: { cancelled: boolean }
- Optional_yieldInterval: number
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.

Overrides BrushShape.createShapeAsync

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.

Overrides BrushShape.estimateBlockCount

getSettings

getSettings(): BrushShapeSettings
Returns BrushShapeSettings
Overrides BrushShape.getSettings