Class Widget

bindPositionToBlockCursor

collisionOffset

collisionRadius

collisionType

location

lockPositionToSurface

snapToBlockLocation

addBoundingBox

• addBoundingBox(
      componentName: string,
      size: Vector3,
      options?: WidgetComponentBoundingBoxOptions,
  ): WidgetComponentBoundingBox

  Parameters

  • componentName: string
  • size: Vector3
  • Optionaloptions: WidgetComponentBoundingBoxOptions

  Returns WidgetComponentBoundingBox

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addClipboardComponent

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

  Parameters

  • componentName: string
  • OptionalclipboardItem: ClipboardItem
  • Optionaloptions: WidgetComponentClipboardOptions

  Returns WidgetComponentClipboard

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addEntityComponent

• addEntityComponent(
      componentName: string,
      actorNameId: string,
      options?: WidgetComponentEntityOptions,
  ): WidgetComponentEntity

  Parameters

  • componentName: string
  • actorNameId: string
  • Optionaloptions: WidgetComponentEntityOptions

  Returns WidgetComponentEntity

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addGizmoComponent

• addGizmoComponent(
      componentName: string,
      options?: WidgetComponentGizmoOptions,
  ): WidgetComponentGizmo

  Parameters

  • componentName: string
  • Optionaloptions: WidgetComponentGizmoOptions

  Returns WidgetComponentGizmo

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addGridComponent

• addGridComponent(
      componentName: string,
      options?: WidgetComponentGridOptions,
  ): WidgetComponentGrid

  Parameters

  • componentName: string
  • Optionaloptions: WidgetComponentGridOptions

  Returns WidgetComponentGrid

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addGuideComponent

• addGuideComponent(
      componentName: string,
      options?: WidgetComponentGuideOptions,
  ): WidgetComponentGuide

  Parameters

  • componentName: string
  • Optionaloptions: WidgetComponentGuideOptions

  Returns WidgetComponentGuide

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

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

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addSplineComponent

• addSplineComponent(
      componentName: string,
      options?: WidgetComponentSplineOptions,
  ): WidgetComponentSpline

  Parameters

  • componentName: string
  • Optionaloptions: WidgetComponentSplineOptions

  Returns WidgetComponentSpline

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addTextComponent

• addTextComponent(
      componentName: string,
      label: string,
      options?: WidgetComponentTextOptions,
  ): WidgetComponentText

  Parameters

  • componentName: string
  • label: string
  • Optionaloptions: WidgetComponentTextOptions

  Returns WidgetComponentText

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

addVolumeOutline

• addVolumeOutline(
      componentName: string,
      volume?: BlockVolumeBase | RelativeVolumeListBlockVolume,
      options?: WidgetComponentVolumeOutlineOptions,
  ): WidgetComponentVolumeOutline

  Parameters

  • componentName: string
  • Optionalvolume: BlockVolumeBase | RelativeVolumeListBlockVolume
  • Optionaloptions: WidgetComponentVolumeOutlineOptions

  Returns WidgetComponentVolumeOutline

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

delete

• delete(): void

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

deleteComponent

• deleteComponent(componentOrName: string | WidgetComponentBase): void

  Parameters

  • componentOrName: string | WidgetComponentBase

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

getComponent

• getComponent(componentName: string): WidgetComponentBase

  Parameters

  • componentName: string

  Returns WidgetComponentBase

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  World Ready

  This function can't be called in early-execution mode.

getComponents

• getComponents(): WidgetComponentBase[]

  Returns WidgetComponentBase[]

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  InvalidWidgetError

  World Ready

  This function can't be called in early-execution mode.

setStateChangeEvent

• setStateChangeEvent(
      eventFunction?: (arg0: WidgetStateChangeEventData) => void,
  ): void

  Parameters

  • OptionaleventFunction: (arg0: WidgetStateChangeEventData) => void

  Returns void

  Remarks

  Write Privilege

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

  Throws

  This function can throw errors.

  InvalidWidgetError

  World Ready

  This function can't be called in early-execution mode.