Class WidgetComponentClipboard

Hierarchy

WidgetComponentBase
- WidgetComponentClipboard

Index

Constructors

Properties

clipboardMirror clipboardNormalizedOrigin clipboardOffset clipboardRotation componentType fillColor location lockToSurface name offset outlineColor showBounds valid visible widget

Methods

delete setStateChangeEvent

Constructors

`Private` constructor

new WidgetComponentClipboard(): WidgetComponentClipboard
Returns WidgetComponentClipboard
Overrides WidgetComponentBase.constructor
- Defined in tmp/package/index.d.ts:3570

Properties

clipboardMirror

clipboardMirror: StructureMirrorAxis

clipboardNormalizedOrigin

clipboardNormalizedOrigin: Vector3

clipboardOffset

clipboardOffset: Vector3

clipboardRotation

clipboardRotation: StructureRotation

`Readonly` componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

fillColor

fillColor: RGBA

`Readonly` location

location: Vector3

Throws

This property can throw when used.

minecraftserver.InvalidWidgetComponentError

lockToSurface

lockToSurface: boolean

Remarks

This property can't be edited in read-only mode.

`Readonly` name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

offset

offset: Vector3

Remarks

This property can't be edited in read-only mode.

outlineColor

outlineColor: RGBA

showBounds

showBounds: boolean

`Readonly` valid

valid: boolean

visible

visible: boolean

`Readonly` widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

Methods

delete

delete(): void
Returns void

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

Throws
This function can throw errors.

InvalidWidgetComponentError
Inherited from WidgetComponentBase.delete
- Defined in tmp/package/index.d.ts:3556

setStateChangeEvent

setStateChangeEvent(eventFunction?): void
Parameters
- Optional eventFunction: ((arg) => void)
  - - (arg): void
    - Parameters
      
      arg: WidgetComponentStateChangeEventData
      
      Returns void
Returns void

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

Throws
This function can throw errors.

InvalidWidgetComponentError
Inherited from WidgetComponentBase.setStateChangeEvent
- Defined in tmp/package/index.d.ts:3565

Class WidgetComponentClipboard

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Returns WidgetComponentClipboard

Properties

clipboardMirror

clipboardNormalizedOrigin

clipboardOffset

clipboardRotation

Readonly componentType

Throws

fillColor

Readonly location

Throws

lockToSurface

Remarks

Readonly name

Throws

offset

Remarks

outlineColor

showBounds

Readonly valid

visible

Readonly widget

Throws

Methods

delete

Returns void

Remarks

Throws

setStateChangeEvent

Parameters

Optional eventFunction: ((arg) => void)

Parameters

arg: WidgetComponentStateChangeEventData

Returns void

Returns void

Remarks

Throws

Settings

Member Visibility

Theme

On This Page

`Private` constructor

`Readonly` componentType

`Readonly` location

`Readonly` name

`Readonly` valid

`Readonly` widget

`Optional` eventFunction: ((arg) => void)