#Class: SingleBlockBrushShape experimental

block

Beta

#Extends

• BrushShape

#Constructors

#Constructor

new SingleBlockBrushShape(): SingleBlockBrushShape

Beta

#Returns

SingleBlockBrushShape

#Remarks

Constructs a new instance of the SingleBlockBrushShape class

#Overrides

BrushShape.constructor

#Accessors

#displayName

#Get Signature

get displayName(): string

Beta

#Returns

string

#Inherited from

BrushShape.displayName

---

#icon

#Get Signature

get icon(): string

Beta

#Returns

string

#Inherited from

BrushShape.icon

---

#id

#Get Signature

get id(): string

Beta

#Returns

string

#Inherited from

BrushShape.id

#Methods

#applySetting()

applySetting(_settings): void

Beta

#Parameters

#_settings

BrushShapeSettings

#Returns

void

#Overrides

BrushShape.applySetting

---

#calculateBounds()

calculateBounds(): BlockBoundingBox

Beta

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

#Overrides

BrushShape.calculateBounds

---

#createSettingsPane()

createSettingsPane(): undefined

Beta

#Returns

undefined

#Overrides

BrushShape.createSettingsPane

---

#createShape()

createShape(): RelativeVolumeListBlockVolume

Beta

#Returns

RelativeVolumeListBlockVolume

#Overrides

BrushShape.createShape

---

#createShapeAsync()

createShapeAsync(_cancelToken?, _yieldInterval?): Promise<RelativeVolumeListBlockVolume>

Beta

#Parameters

#_cancelToken?

#cancelled

boolean

#_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.

#Overrides

BrushShape.createShapeAsync

---

#estimateBlockCount()

estimateBlockCount(): number

Beta

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

#Overrides

BrushShape.estimateBlockCount

---

#getSettings()

getSettings(): BrushShapeSettings

Beta

#Returns

BrushShapeSettings

#Overrides

BrushShape.getSettings

#同领域相关

• BlockIdentifierListObservableValidator
• BlockIdentifierObservableValidator
• BlockMaskList
• BlockMaskListType
• BlockPalette
• BlockPaletteItemType