Class Widget

Hierarchy

Widget

Constructors

`Private` constructor

new Widget(): Widget
Returns Widget
- Defined in tmp/package/index.d.ts:3479

Properties

bindPositionToBlockCursor

bindPositionToBlockCursor: boolean

Remarks

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

collisionOffset

collisionOffset: Vector3

Remarks

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

collisionRadius

collisionRadius: number

Remarks

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

location

location: Vector3

Remarks

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

lockPositionToSurface

lockPositionToSurface: boolean

Remarks

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

`Readonly` selectable

selectable: boolean

Throws

This property can throw when used.

InvalidWidgetError

selected

selected: boolean

showBoundingBox

showBoundingBox: boolean

showCollisionRadius

showCollisionRadius: boolean

snapToBlockLocation

snapToBlockLocation: boolean

Remarks

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

visible

visible: boolean

Methods

addClipboardComponent

addClipboardComponent(componentName, clipboardItem?, options?): WidgetComponentClipboard
Parameters
- componentName: string
- Optional clipboardItem: ClipboardItem
- Optional options: WidgetComponentClipboardOptions
Returns WidgetComponentClipboard

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3536

addEntityComponent

addEntityComponent(componentName, actorNameId, options?): WidgetComponentEntity
Parameters
- componentName: string
- actorNameId: string
- Optional options: WidgetComponentEntityOptions
Returns WidgetComponentEntity

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3551

addGizmoComponent

addGizmoComponent(componentName, options?): WidgetComponentGizmo
Parameters
- componentName: string
- Optional options: WidgetComponentGizmoOptions
Returns WidgetComponentGizmo

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3566

addGuideComponent

addGuideComponent(componentName, options?): WidgetComponentGuide
Parameters
- componentName: string
- Optional options: WidgetComponentGuideOptions
Returns WidgetComponentGuide

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3577

addRenderPrimitiveComponent

addRenderPrimitiveComponent(componentName, primitiveType, options?): WidgetComponentRenderPrimitive
Parameters
- componentName: string
- primitiveType: WidgetComponentRenderPrimitiveTypeAxialSphere | WidgetComponentRenderPrimitiveTypeBox | WidgetComponentRenderPrimitiveTypeDisc | WidgetComponentRenderPrimitiveTypeLine
- Optional options: WidgetComponentRenderPrimitiveOptions
Returns WidgetComponentRenderPrimitive

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3588

addSplineComponent

addSplineComponent(componentName, options?): WidgetComponentSpline
Parameters
- componentName: string
- Optional options: WidgetComponentSplineOptions
Returns WidgetComponentSpline

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3607

addTextComponent

addTextComponent(componentName, label, options?): WidgetComponentText
Parameters
- componentName: string
- label: string
- Optional options: WidgetComponentTextOptions
Returns WidgetComponentText

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3618

delete

delete(): void
Returns void

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

Throws
This function can throw errors.

Error

InvalidWidgetError

InvalidWidgetGroupError
- Defined in tmp/package/index.d.ts:3631

deleteComponent

deleteComponent(componentOrName): void
Parameters
- componentOrName: string | WidgetComponentBase
Returns void

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

Throws
This function can throw errors.

Error

InvalidWidgetComponentError

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3644

getComponent

getComponent(componentName): WidgetComponentBase
Parameters
- componentName: string
Returns WidgetComponentBase

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

Throws
This function can throw errors.

Error

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3655

getComponents

getComponents(): WidgetComponentBase[]
Returns WidgetComponentBase[]

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

Throws
This function can throw errors.

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3664

setStateChangeEvent

setStateChangeEvent(eventFunction?): void
Parameters
- Optional eventFunction: ((arg0) => void)
  - - (arg0): void
    - Parameters
      
      arg0: WidgetStateChangeEventData
      
      Returns void
Returns void

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

Throws
This function can throw errors.

InvalidWidgetError
- Defined in tmp/package/index.d.ts:3673

Class Widget

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Private constructor

Returns Widget

Properties

bindPositionToBlockCursor

Remarks

collisionOffset

Remarks

collisionRadius

Remarks

location

Remarks

lockPositionToSurface

Remarks

Readonly selectable

Throws

selected

showBoundingBox

showCollisionRadius

snapToBlockLocation

Remarks

visible

Methods

addClipboardComponent

Parameters

componentName: string

Optional clipboardItem: ClipboardItem

Optional options: WidgetComponentClipboardOptions

Returns WidgetComponentClipboard

Remarks

Throws

addEntityComponent

Parameters

componentName: string

actorNameId: string

Optional options: WidgetComponentEntityOptions

Returns WidgetComponentEntity

Remarks

Throws

addGizmoComponent

Parameters

componentName: string

Optional options: WidgetComponentGizmoOptions

Returns WidgetComponentGizmo

Remarks

Throws

addGuideComponent

Parameters

componentName: string

Optional options: WidgetComponentGuideOptions

Returns WidgetComponentGuide

Remarks

Throws

addRenderPrimitiveComponent

Parameters

componentName: string

primitiveType: WidgetComponentRenderPrimitiveTypeAxialSphere | WidgetComponentRenderPrimitiveTypeBox | WidgetComponentRenderPrimitiveTypeDisc | WidgetComponentRenderPrimitiveTypeLine

Optional options: WidgetComponentRenderPrimitiveOptions

Returns WidgetComponentRenderPrimitive

Remarks

Throws

addSplineComponent

Parameters

componentName: string

Optional options: WidgetComponentSplineOptions

Returns WidgetComponentSpline

Remarks

Throws

addTextComponent

Parameters

componentName: string

label: string

Optional options: WidgetComponentTextOptions

Returns WidgetComponentText

`Private` constructor

`Readonly` selectable

`Optional` clipboardItem: ClipboardItem

`Optional` options: WidgetComponentClipboardOptions

`Optional` options: WidgetComponentEntityOptions

`Optional` options: WidgetComponentGizmoOptions

`Optional` options: WidgetComponentGuideOptions

`Optional` options: WidgetComponentRenderPrimitiveOptions

`Optional` options: WidgetComponentSplineOptions

`Optional` options: WidgetComponentTextOptions

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