Class Widget

bindPositionToBlockCursor

collisionOffset

collisionRadius

location

lockPositionToSurface

Readonly selectable

selected

showBoundingBox

showCollisionRadius

snapToBlockLocation

visible

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

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

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

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

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

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

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

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

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

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

getComponents

• getComponents(): WidgetComponentBase[]

• Returns WidgetComponentBase[]

  Remarks

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

  Throws

  This function can throw errors.

  InvalidWidgetError

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