Class Widget

bindPositionToBlockCursor

collisionOffset

collisionRadius

location

lockPositionToSurface

Readonlyselectable

selected

showBoundingBox

showCollisionRadius

snapToBlockLocation

visible

addClipboardComponent

• addClipboardComponent(
      componentName: string,
      clipboardItem?: ClipboardItem,
      options?: WidgetComponentClipboardOptions,
  ): WidgetComponentClipboard

• Parameters

  • componentName: string
  • OptionalclipboardItem: ClipboardItem
  • Optionaloptions: 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: string,
      actorNameId: string,
      options?: WidgetComponentEntityOptions,
  ): WidgetComponentEntity

• Parameters

  • componentName: string
  • actorNameId: string
  • Optionaloptions: 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: string,
      options?: WidgetComponentGizmoOptions,
  ): WidgetComponentGizmo

• Parameters

  • componentName: string
  • Optionaloptions: 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: string,
      options?: WidgetComponentGuideOptions,
  ): WidgetComponentGuide

• Parameters

  • componentName: string
  • Optionaloptions: 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: string,
      primitiveType:
          | WidgetComponentRenderPrimitiveTypeAxialSphere
          | WidgetComponentRenderPrimitiveTypeBox
          | WidgetComponentRenderPrimitiveTypeDisc
          | WidgetComponentRenderPrimitiveTypeLine,
      options?: WidgetComponentRenderPrimitiveOptions,
  ): WidgetComponentRenderPrimitive

• Parameters

  • componentName: string
  • primitiveType:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeLine
  • Optionaloptions: 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: string,
      options?: WidgetComponentSplineOptions,
  ): WidgetComponentSpline

• Parameters

  • componentName: string
  • Optionaloptions: 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: string,
      label: string,
      options?: WidgetComponentTextOptions,
  ): WidgetComponentText

• Parameters

  • componentName: string
  • label: string
  • Optionaloptions: 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: string | WidgetComponentBase): 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: string): 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?: (arg: WidgetStateChangeEventData) => void,
  ): void

• Parameters

  • OptionaleventFunction: (arg: WidgetStateChangeEventData) => void

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

  InvalidWidgetError