Class WidgetComponentGuide

Hierarchy

WidgetComponentBase
- WidgetComponentGuide

Index

Constructors

Properties

componentType location lockToSurface name offset valid visible widget

Methods

delete setStateChangeEvent

Constructors

`Private` constructor

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

Properties

`Readonly` componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

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

`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:3793

setStateChangeEvent

setStateChangeEvent(eventFunction?): void
Parameters
- Optional eventFunction: ((arg0) => void)
  - - (arg0): void
    - Parameters
      
      arg0: 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:3802