类 Widget

世界修改bindPositionToBlockCursor

世界修改collisionOffset

世界修改collisionRadius

世界修改collisionType

世界修改ignoreEditorModeVisibilityOverride

世界修改location

世界修改lockPositionToSurface

世界修改snapToBlockLocation

addBoundingBox

• addBoundingBox(
      componentName: string,
      size: Vector3,
      options?: WidgetComponentBoundingBoxOptions,
  ): WidgetComponentBoundingBox
  世界修改

  参数

  • componentName: string
  • size: Vector3
  • 可选options: WidgetComponentBoundingBoxOptions

  返回 WidgetComponentBoundingBox

  备注

  抛出

addClipboardComponent

• addClipboardComponent(
      componentName: string,
      clipboardItem?: ClipboardItem | EditorStructure,
      options?: WidgetComponentClipboardOptions,
  ): WidgetComponentClipboard
  世界修改

  参数

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

  返回 WidgetComponentClipboard

  备注

  抛出

addEntityComponent

• addEntityComponent(
      componentName: string,
      actorNameId: string,
      options?: WidgetComponentEntityOptions,
  ): WidgetComponentEntity
  世界修改

  参数

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

  返回 WidgetComponentEntity

  备注

  抛出

addGizmoComponent

• addGizmoComponent(
      componentName: string,
      options?: WidgetComponentGizmoOptions,
  ): WidgetComponentGizmo
  世界修改

  参数

  • componentName: string
  • 可选options: WidgetComponentGizmoOptions

  返回 WidgetComponentGizmo

  备注

  抛出

addGridComponent

• addGridComponent(
      componentName: string,
      options?: WidgetComponentGridOptions,
  ): WidgetComponentGrid
  世界修改

  参数

  • componentName: string
  • 可选options: WidgetComponentGridOptions

  返回 WidgetComponentGrid

  备注

  抛出

addGuideComponent

• addGuideComponent(
      componentName: string,
      options?: WidgetComponentGuideOptions,
  ): WidgetComponentGuide
  世界修改

  参数

  • componentName: string
  • 可选options: WidgetComponentGuideOptions

  返回 WidgetComponentGuide

  备注

  抛出

addRenderPlaneComponent

• addRenderPlaneComponent(
      componentName: string,
      options?: WidgetComponentRenderPlaneOptions,
  ): WidgetComponentRenderPlane
  世界修改

  参数

  • componentName: string
  • 可选options: WidgetComponentRenderPlaneOptions

  返回 WidgetComponentRenderPlane

  备注

  抛出

addRenderPrimitiveComponent

• addRenderPrimitiveComponent(
      componentName: string,
      primitiveType:
          | WidgetComponentRenderPrimitiveTypeAxialSphere
          | WidgetComponentRenderPrimitiveTypeBox
          | WidgetComponentRenderPrimitiveTypeCone
          | WidgetComponentRenderPrimitiveTypeCuboid
          | WidgetComponentRenderPrimitiveTypeCylinder
          | WidgetComponentRenderPrimitiveTypeDisc
          | WidgetComponentRenderPrimitiveTypeEllipsoid
          | WidgetComponentRenderPrimitiveTypeLine
          | WidgetComponentRenderPrimitiveTypePyramid
          | WidgetComponentRenderPrimitiveTypeWireframeMesh,
      options?: WidgetComponentRenderPrimitiveOptions,
  ): WidgetComponentRenderPrimitive
  世界修改

  参数

  • componentName: string
  • primitiveType:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeCone
        | WidgetComponentRenderPrimitiveTypeCuboid
        | WidgetComponentRenderPrimitiveTypeCylinder
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeEllipsoid
        | WidgetComponentRenderPrimitiveTypeLine
        | WidgetComponentRenderPrimitiveTypePyramid
        | WidgetComponentRenderPrimitiveTypeWireframeMesh
  • 可选options: WidgetComponentRenderPrimitiveOptions

  返回 WidgetComponentRenderPrimitive

  备注

  抛出

addSplineComponent

• addSplineComponent(
      componentName: string,
      options?: WidgetComponentSplineOptions,
  ): WidgetComponentSpline
  世界修改

  参数

  • componentName: string
  • 可选options: WidgetComponentSplineOptions

  返回 WidgetComponentSpline

  备注

  抛出

addTextComponent

• addTextComponent(
      componentName: string,
      label: string,
      options?: WidgetComponentTextOptions,
  ): WidgetComponentText
  世界修改

  参数

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

  返回 WidgetComponentText

  备注

  抛出

addVolumeOutline

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

  参数

  • componentName: string
  • 可选volume: BlockVolumeBase | RelativeVolumeListBlockVolume
  • 可选options: WidgetComponentVolumeOutlineOptions

  返回 WidgetComponentVolumeOutline

  备注

  抛出

delete

• delete(): void
  世界修改

  返回 void

  备注

  抛出

deleteComponent

• deleteComponent(componentOrName: string | WidgetComponentBase): void
  世界修改

  参数

  • componentOrName: string | WidgetComponentBase

  返回 void

  备注

  抛出

getComponent

• getComponent(componentName: string): WidgetComponentBase
  世界修改

  参数

  • componentName: string

  返回 WidgetComponentBase

  备注

  抛出

getComponents

• getComponents(): WidgetComponentBase[]
  世界修改

  返回 WidgetComponentBase[]

  备注

  抛出

  InvalidWidgetError

setStateChangeEvent

• setStateChangeEvent(
      eventFunction?: (arg0: WidgetStateChangeEventData) => void,
  ): void
  世界修改

  参数

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

  返回 void

  备注

  抛出

  InvalidWidgetError