Class BrushShapeManagerBeta

Optional Readonly BetaactiveBrushShape

Optional Readonly BetaactiveBrushVolume

Readonly BetabrushShapeNames

activateBrushShape

• activateBrushShape(name: string): CompoundBlockVolume
  Beta

  Parameters

  • name: string

  Returns CompoundBlockVolume

  Remarks

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

  Throws

  This function can throw errors.

getBrushVolume

• getBrushVolume(
      origin: Vector3,
      pipeline: BrushPipelineOperation[],
  ): CompoundBlockVolume
  Beta

  Parameters

  • origin: Vector3
  • pipeline: BrushPipelineOperation[]

  Returns CompoundBlockVolume

  Remarks

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

getSettingsUIElements

• getSettingsUIElements(brushName: string): SettingsUIElement[]
  Beta

  Parameters

  • brushName: string

  Returns SettingsUIElement[]

  Remarks

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

  Throws

  This function can throw errors.

registerBrushShape

• registerBrushShape(
      name: string,
      icon: string,
      rebuild: () => CompoundBlockVolume,
      getSettingsUIElements: () => SettingsUIElement[],
  ): void
  Beta

  Parameters

  • 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: string,
      newValue: string | number | boolean | Vector3,
  ): boolean
  Beta

  Parameters

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