类 Widget实验性

实验性bindPositionToBlockCursor

实验性collisionOffset

实验性collisionRadius

实验性location

实验性lockPositionToSurface

只读 实验性selectable

实验性selected

实验性showBoundingBox

实验性showCollisionRadius

实验性snapToBlockLocation

实验性visible

addClipboardComponent

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

  参数

  • componentName: string
  • 可选clipboardItem: ClipboardItem
  • 可选options: WidgetComponentClipboardOptions

  返回 WidgetComponentClipboard

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

addEntityComponent

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

  参数

  • componentName: string
  • actorNameId: string
  • 可选options: WidgetComponentEntityOptions

  返回 WidgetComponentEntity

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

addGizmoComponent

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

  参数

  • componentName: string
  • 可选options: WidgetComponentGizmoOptions

  返回 WidgetComponentGizmo

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

addGuideComponent

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

  参数

  • componentName: string
  • 可选options: WidgetComponentGuideOptions

  返回 WidgetComponentGuide

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

addRenderPrimitiveComponent

• addRenderPrimitiveComponent(
      componentName: string,
      primitiveType:
          | WidgetComponentRenderPrimitiveTypeAxialSphere
          | WidgetComponentRenderPrimitiveTypeBox
          | WidgetComponentRenderPrimitiveTypeDisc
          | WidgetComponentRenderPrimitiveTypeLine,
      options?: WidgetComponentRenderPrimitiveOptions,
  ): WidgetComponentRenderPrimitive
• 实验性

  参数

  • componentName: string
  • primitiveType:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeLine
  • 可选options: WidgetComponentRenderPrimitiveOptions

  返回 WidgetComponentRenderPrimitive

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

addSplineComponent

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

  参数

  • componentName: string
  • 可选options: WidgetComponentSplineOptions

  返回 WidgetComponentSpline

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

addTextComponent

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

  参数

  • componentName: string
  • label: string
  • 可选options: WidgetComponentTextOptions

  返回 WidgetComponentText

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

delete

• delete(): void
• 实验性

  返回 void

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

  InvalidWidgetGroupError

deleteComponent

• deleteComponent(componentOrName: string | WidgetComponentBase): void
• 实验性

  参数

  • componentOrName: string | WidgetComponentBase

  返回 void

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetComponentError

  InvalidWidgetError

getComponent

• getComponent(componentName: string): WidgetComponentBase
• 实验性

  参数

  • componentName: string

  返回 WidgetComponentBase

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  Error

  InvalidWidgetError

getComponents

• getComponents(): WidgetComponentBase[]
• 实验性

  返回 WidgetComponentBase[]

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  InvalidWidgetError

setStateChangeEvent

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

  参数

  • 可选eventFunction: (arg0: WidgetStateChangeEventData) => void

  返回 void

  备注

  无法在只读模式下调用此函数，详见 WorldBeforeEvents。

  抛出

  This function can throw errors.

  InvalidWidgetError