Class BrushShapeManager

Optional Readonly activeBrushShape

Optional Readonly activeBrushVolume

Readonly brushShapeList

activateBrushShape

• activateBrushShape(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

activateBrushTool

• activateBrushTool(): void

• Returns void

  Remarks

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

beginPainting

• beginPainting(): void

• Returns void

  Remarks

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

deactivateBrushTool

• deactivateBrushTool(): void

• Returns void

  Remarks

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

endPainting

• endPainting(): void

• Returns void

  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

setBlockPaletteOverride

• setBlockPaletteOverride(overrideBlock?): void

• Parameters

  • Optional overrideBlock: string | BlockPermutation | BlockType

    Optional

  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.

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