Class BrushShapeManager

Optional ReadonlyactiveBrushShape

Optional ReadonlyactiveBrushVolume

ReadonlybrushShapeList

activateBrushTool

• activateBrushTool(): void

• Returns void

  Remarks

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

beginPainting

• beginPainting(onComplete: (arg: PaintCompletionState) => void): void

• Parameters

  • onComplete: (arg: PaintCompletionState) => void

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Error

deactivateBrushTool

• deactivateBrushTool(): void

• Returns void

  Remarks

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

endPainting

• endPainting(cancelled: boolean): void

• Parameters

  • cancelled: boolean

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Error

getBrushShapeOffset

• getBrushShapeOffset(): Vector3

• Returns Vector3

  Remarks

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

getSettingsUIElements

• getSettingsUIElements(brushName: string): SettingsUIElement[]

• Parameters

  • brushName: string

  Returns SettingsUIElement[]

  Remarks

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

  Throws

  This function can throw errors.

  Error

registerBrushShape

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

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

  Error

setBrushMask

• setBrushMask(mask: BlockMaskList): void

• Parameters

  • mask: BlockMaskList

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Error

setBrushShape

• setBrushShape(shape: Vector3[] | CompoundBlockVolume): void

• Parameters

  • shape: Vector3[] | CompoundBlockVolume

  Returns void

  Remarks

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

setBrushShapeOffset

• setBrushShapeOffset(offset: Vector3): void

• Parameters

  • offset: Vector3

  Returns void

  Remarks

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

setBrushShapeVisible

• setBrushShapeVisible(visible: boolean): void

• Parameters

  • visible: boolean

  Returns void

  Remarks

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

setSmoothStrength

• setSmoothStrength(smoothStrength: number): void

• Parameters

  • smoothStrength: number

  Returns void

  Remarks

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

singlePaint

• singlePaint(onComplete: (arg: PaintCompletionState) => void): void

• Parameters

  • onComplete: (arg: PaintCompletionState) => void

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Error

switchBrushPaintMode

• switchBrushPaintMode(paintMode: PaintMode): void

• Parameters

  • paintMode: PaintMode

  Returns void

  Remarks

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

switchBrushShape

• switchBrushShape(name: string): CompoundBlockVolume

• Parameters

  • name: string

  Returns CompoundBlockVolume

  Remarks

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

  Throws

  This function can throw errors.

  minecraftserver.Error

uiSettingValueChanged

• uiSettingValueChanged(
      elementName: string,
      newValue: string | number | boolean | Vector3,
  ): boolean

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

  Error