Class BrushShapeManager

Optional Readonly activeBrushShape

Optional Readonly activeBrushVolume

Readonly brushShapeList

activateBrushTool

• activateBrushTool(): void

• Returns void

  Remarks

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

beginPainting

• beginPainting(onComplete): void

• Parameters

  • onComplete: ((arg) => void)

    • • (arg): void

      • Parameters

        • arg: PaintCompletionState

        Returns 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): 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): 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, icon, rebuild, getSettingsUIElements): void

• Parameters

  • name: string

  • icon: string

  • rebuild: (() => CompoundBlockVolume)

    • • (): CompoundBlockVolume

      • Returns CompoundBlockVolume

  • getSettingsUIElements: (() => SettingsUIElement[])

    • • (): SettingsUIElement[]

      • Returns SettingsUIElement[]

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Error

setBrushMask

• setBrushMask(mask): 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): void

• Parameters

  • shape: Vector3[] | CompoundBlockVolume

  Returns void

  Remarks

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

setBrushShapeOffset

• setBrushShapeOffset(offset): void

• Parameters

  • offset: Vector3

  Returns void

  Remarks

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

setBrushShapeVisible

• setBrushShapeVisible(visible): void

• Parameters

  • visible: boolean

  Returns void

  Remarks

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

setSmoothStrength

• setSmoothStrength(smoothStrength): void

• Parameters

  • smoothStrength: number

  Returns void

  Remarks

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

singlePaint

• singlePaint(onComplete): void

• Parameters

  • onComplete: ((arg) => void)

    • • (arg): void

      • Parameters

        • arg: PaintCompletionState

        Returns void

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Error

switchBrushPaintMode

• switchBrushPaintMode(paintMode): void

• Parameters

  • paintMode: PaintMode

  Returns void

  Remarks

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

switchBrushShape

• switchBrushShape(name): 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, newValue): 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