Class Widget`Beta`

Properties

`Beta`bindPositionToBlockCursor

bindPositionToBlockCursor: boolean

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Beta`collisionOffset

collisionOffset: Vector3

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Beta`collisionRadius

collisionRadius: number

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Beta`collisionType

collisionType: WidgetCollisionType

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Optional` `Beta`dimensionId

dimensionId?: string

`Readonly` `Beta`group

group: WidgetGroup

Throws

This property can throw when used.

InvalidWidgetError

`Beta`ignoreEditorModeVisibilityOverride

ignoreEditorModeVisibilityOverride: boolean

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Beta`location

location: Vector3

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Beta`lockPositionToSurface

lockPositionToSurface: boolean

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Readonly` `Beta`selectable

selectable: boolean

Throws

This property can throw when used.

InvalidWidgetError

`Beta`selected

selected: boolean

`Beta`showBoundingBox

showBoundingBox: boolean

`Beta`showCollisionRadius

showCollisionRadius: boolean

`Beta`snapToBlockLocation

snapToBlockLocation: boolean

Remarks

Privilege

restricted-execution-read-only - This property can't be edited in restricted-execution mode.

`Beta`visible

visible: boolean

`Readonly` `Beta`widgetName

widgetName: string

Methods

addBoundingBox

addBoundingBox(
    componentName: string,
    size: Vector3,
    options?: WidgetComponentBoundingBoxOptions,
): WidgetComponentBoundingBox
Beta
Parameters
- componentName: string
- size: Vector3
- Optionaloptions: WidgetComponentBoundingBoxOptions
Returns WidgetComponentBoundingBox
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5331

addClipboardComponent

addClipboardComponent(
    componentName: string,
    clipboardItem?: ClipboardItem | EditorStructure,
    options?: WidgetComponentClipboardOptions,
): WidgetComponentClipboard
Beta
Parameters
- componentName: string
- OptionalclipboardItem: ClipboardItem | EditorStructure
- Optionaloptions: WidgetComponentClipboardOptions
Returns WidgetComponentClipboard
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5342

addEntityComponent

addEntityComponent(
    componentName: string,
    actorNameId: string,
    options?: WidgetComponentEntityOptions,
): WidgetComponentEntity
Beta
Parameters
- componentName: string
- actorNameId: string
- Optionaloptions: WidgetComponentEntityOptions
Returns WidgetComponentEntity
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5353

addGizmoComponent

addGizmoComponent(
componentName: string,
options?: WidgetComponentGizmoOptions,
): WidgetComponentGizmo
Beta
Parameters
- componentName: string
- Optionaloptions: WidgetComponentGizmoOptions
Returns WidgetComponentGizmo
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5364

addGridComponent

addGridComponent(
componentName: string,
options?: WidgetComponentGridOptions,
): WidgetComponentGrid
Beta
Parameters
- componentName: string
- Optionaloptions: WidgetComponentGridOptions
Returns WidgetComponentGrid
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5371

addGuideComponent

addGuideComponent(
componentName: string,
options?: WidgetComponentGuideOptions,
): WidgetComponentGuide
Beta
Parameters
- componentName: string
- Optionaloptions: WidgetComponentGuideOptions
Returns WidgetComponentGuide
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5378

addRenderPlaneComponent

addRenderPlaneComponent(
componentName: string,
options?: WidgetComponentRenderPlaneOptions,
): WidgetComponentRenderPlane
Beta
Parameters
- componentName: string
- Optionaloptions: WidgetComponentRenderPlaneOptions
Returns WidgetComponentRenderPlane
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5385

addRenderPrimitiveComponent

addRenderPrimitiveComponent(
    componentName: string,
    primitiveType:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeCone
        | WidgetComponentRenderPrimitiveTypeCuboid
        | WidgetComponentRenderPrimitiveTypeCylinder
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeEllipsoid
        | WidgetComponentRenderPrimitiveTypeLine
        | WidgetComponentRenderPrimitiveTypePyramid
        | WidgetComponentRenderPrimitiveTypeWireframeMesh,
    options?: WidgetComponentRenderPrimitiveOptions,
): WidgetComponentRenderPrimitive
Beta
Parameters
- componentName: string
- primitiveType:
      | WidgetComponentRenderPrimitiveTypeAxialSphere
      | WidgetComponentRenderPrimitiveTypeBox
      | WidgetComponentRenderPrimitiveTypeCone
      | WidgetComponentRenderPrimitiveTypeCuboid
      | WidgetComponentRenderPrimitiveTypeCylinder
      | WidgetComponentRenderPrimitiveTypeDisc
      | WidgetComponentRenderPrimitiveTypeEllipsoid
      | WidgetComponentRenderPrimitiveTypeLine
      | WidgetComponentRenderPrimitiveTypePyramid
      | WidgetComponentRenderPrimitiveTypeWireframeMesh
- Optionaloptions: WidgetComponentRenderPrimitiveOptions
Returns WidgetComponentRenderPrimitive
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5395

addSplineComponent

addSplineComponent(
componentName: string,
options?: WidgetComponentSplineOptions,
): WidgetComponentSpline
Beta
Parameters
- componentName: string
- Optionaloptions: WidgetComponentSplineOptions
Returns WidgetComponentSpline
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5416

addTextComponent

addTextComponent(
    componentName: string,
    label: string,
    options?: WidgetComponentTextOptions,
): WidgetComponentText
Beta
Parameters
- componentName: string
- label: string
- Optionaloptions: WidgetComponentTextOptions
Returns WidgetComponentText
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5423

addVolumeOutline

addVolumeOutline(
    componentName: string,
    volume?: BlockVolumeBase | RelativeVolumeListBlockVolume,
    options?: WidgetComponentVolumeOutlineOptions,
): WidgetComponentVolumeOutline
Beta
Parameters
- componentName: string
- Optionalvolume: BlockVolumeBase | RelativeVolumeListBlockVolume
- Optionaloptions: WidgetComponentVolumeOutlineOptions
Returns WidgetComponentVolumeOutline
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5430

delete

delete(): void
Beta
Returns void
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5441

deleteComponent

deleteComponent(componentOrName: string | WidgetComponentBase): void
Beta
Parameters
- componentOrName: string | WidgetComponentBase
Returns void
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5448

getComponent

getComponent(componentName: string): WidgetComponentBase
Beta
Parameters
- componentName: string
Returns WidgetComponentBase
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.
- Defined in tmp/package/index.d.ts:5455

getComponents

getComponents(): WidgetComponentBase[]
Beta
Returns WidgetComponentBase[]
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidWidgetError
- Defined in tmp/package/index.d.ts:5464

setStateChangeEvent

setStateChangeEvent(
eventFunction?: (arg0: WidgetStateChangeEventData) => void,
): void
Beta
Parameters
- OptionaleventFunction: (arg0: WidgetStateChangeEventData) => void
Returns void
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidWidgetError
- Defined in tmp/package/index.d.ts:5473

Class WidgetBeta

Index

Properties

Methods

Properties

BetabindPositionToBlockCursor

Remarks

Privilege

BetacollisionOffset

Remarks

Privilege

BetacollisionRadius

Remarks

Privilege

BetacollisionType

Remarks

Privilege

Optional BetadimensionId

Readonly Betagroup

Throws

BetaignoreEditorModeVisibilityOverride

Remarks

Privilege

Betalocation

Remarks

Privilege

BetalockPositionToSurface

Remarks

Privilege

Readonly Betaselectable

Throws

Betaselected

BetashowBoundingBox

BetashowCollisionRadius

BetasnapToBlockLocation

Remarks

Privilege

Betavisible

Readonly BetawidgetName

Methods

addBoundingBox

Parameters

Returns WidgetComponentBoundingBox

Remarks

Privilege

Throws

addClipboardComponent

Parameters

Returns WidgetComponentClipboard

Remarks

Privilege

Throws

addEntityComponent

Parameters

Returns WidgetComponentEntity

Remarks

Privilege

Throws

addGizmoComponent

Parameters

Returns WidgetComponentGizmo

Remarks

Privilege

Throws

addGridComponent

Parameters

Returns WidgetComponentGrid

Remarks

Privilege

Throws

addGuideComponent

Parameters

Returns WidgetComponentGuide

Remarks

Privilege

Throws

addRenderPlaneComponent

Parameters

Returns WidgetComponentRenderPlane

Remarks

Class Widget`Beta`

`Beta`bindPositionToBlockCursor

`Beta`collisionOffset

`Beta`collisionRadius

`Beta`collisionType

`Optional` `Beta`dimensionId

`Readonly` `Beta`group

`Beta`ignoreEditorModeVisibilityOverride

`Beta`location

`Beta`lockPositionToSurface

`Readonly` `Beta`selectable

`Beta`selected

`Beta`showBoundingBox

`Beta`showCollisionRadius

`Beta`snapToBlockLocation

`Beta`visible

`Readonly` `Beta`widgetName