Class: BrushShapeManager

Constructors

new BrushShapeManager()

private new BrushShapeManager(): BrushShapeManager

Returns

BrushShapeManager

Properties

activeBrushShape?

optional readonly activeBrushShape: BrushShape

---

activeBrushVolume?

optional readonly activeBrushVolume: CompoundBlockVolume

---

brushShapeNames

readonly brushShapeNames: string[]

Methods

activateBrushShape()

activateBrushShape(name): CompoundBlockVolume

Parameters

Parameter	Type
name	string

Returns

CompoundBlockVolume

Remarks

This function can't be called in read-only mode.

Throws

This function can throw errors.

---

getSettingsUIElements()

getSettingsUIElements(brushName): SettingsUIElement[]

Parameters

Parameter	Type
brushName	string

Returns

SettingsUIElement[]

Remarks

This function can't be called in read-only mode.

Throws

This function can throw errors.

---

registerBrushShape()

registerBrushShape(name, icon, rebuild, getSettingsUIElements): void

Parameters

Parameter	Type
name	string
icon	string
rebuild	() => CompoundBlockVolume
getSettingsUIElements	() => SettingsUIElement[]

Returns

void

Remarks

This function can't be called in read-only mode.

Throws

This function can throw errors.

---

uiSettingValueChanged()

uiSettingValueChanged(elementName, newValue): boolean

Parameters

Parameter	Type
elementName	string
newValue	string | number | boolean | Vector3

Returns

boolean

Remarks

This function can't be called in read-only mode.

Throws

This function can throw errors.