Class Widget`Beta`

Properties

`Beta`bindPositionToBlockCursor

bindPositionToBlockCursor: boolean

Remarks

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

`Beta`collisionOffset

collisionOffset: Vector3

Remarks

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

`Beta`collisionRadius

collisionRadius: number

Remarks

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

`Beta`location

location: Vector3

Remarks

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

`Beta`lockPositionToSurface

lockPositionToSurface: boolean

Remarks

This property can't be edited in read-only 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

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

`Beta`visible

visible: boolean

Methods

addClipboardComponent

addClipboardComponent(
    componentName: string,
    clipboardItem?: ClipboardItem,
    options?: WidgetComponentClipboardOptions,
): WidgetComponentClipboard
Beta
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
- Defined in tmp/package/index.d.ts:3605

addEntityComponent

addEntityComponent(
    componentName: string,
    actorNameId: string,
    options?: WidgetComponentEntityOptions,
): WidgetComponentEntity
Beta
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
- Defined in tmp/package/index.d.ts:3620

addGizmoComponent

addGizmoComponent(
componentName: string,
options?: WidgetComponentGizmoOptions,
): WidgetComponentGizmo
Beta
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
- Defined in tmp/package/index.d.ts:3635

addGuideComponent

addGuideComponent(
componentName: string,
options?: WidgetComponentGuideOptions,
): WidgetComponentGuide
Beta
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
- Defined in tmp/package/index.d.ts:3646

addRenderPrimitiveComponent

addRenderPrimitiveComponent(
    componentName: string,
    primitiveType:
        | WidgetComponentRenderPrimitiveTypeAxialSphere
        | WidgetComponentRenderPrimitiveTypeBox
        | WidgetComponentRenderPrimitiveTypeDisc
        | WidgetComponentRenderPrimitiveTypeLine,
    options?: WidgetComponentRenderPrimitiveOptions,
): WidgetComponentRenderPrimitive
Beta
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
- Defined in tmp/package/index.d.ts:3657

addSplineComponent

addSplineComponent(
componentName: string,
options?: WidgetComponentSplineOptions,
): WidgetComponentSpline
Beta
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
- Defined in tmp/package/index.d.ts:3676

addTextComponent

addTextComponent(
    componentName: string,
    label: string,
    options?: WidgetComponentTextOptions,
): WidgetComponentText
Beta
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
- Defined in tmp/package/index.d.ts:3687

delete

delete(): void
Beta
Returns void
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

InvalidWidgetError

InvalidWidgetGroupError
- Defined in tmp/package/index.d.ts:3700

deleteComponent

deleteComponent(componentOrName: string | WidgetComponentBase): void
Beta
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
- Defined in tmp/package/index.d.ts:3713

getComponent

getComponent(componentName: string): WidgetComponentBase
Beta
Parameters
- componentName: string
Returns WidgetComponentBase
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

Error

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

getComponents

getComponents(): WidgetComponentBase[]
Beta
Returns WidgetComponentBase[]
Remarks
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

setStateChangeEvent

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

Throws
This function can throw errors.

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

Class WidgetBeta

Index

Properties

Methods

Properties

BetabindPositionToBlockCursor

Remarks

BetacollisionOffset

Remarks

BetacollisionRadius

Remarks

Betalocation

Remarks

BetalockPositionToSurface

Remarks

Readonly Betaselectable

Throws

Betaselected

BetashowBoundingBox

BetashowCollisionRadius

BetasnapToBlockLocation

Remarks

Betavisible

Methods

addClipboardComponent

Parameters

Returns WidgetComponentClipboard

Remarks

Throws

addEntityComponent

Parameters

Returns WidgetComponentEntity

Remarks

Throws

addGizmoComponent

Parameters

Returns WidgetComponentGizmo

Remarks

Throws

addGuideComponent

Parameters

Returns WidgetComponentGuide

Remarks

Throws

addRenderPrimitiveComponent

Parameters

Returns WidgetComponentRenderPrimitive

Remarks

Throws

addSplineComponent

Parameters

Returns WidgetComponentSpline

Remarks

Throws

addTextComponent

Parameters

Returns WidgetComponentText

Remarks

Throws

delete

Returns void

Remarks

Throws

deleteComponent

Parameters

Returns void

Remarks

Throws

getComponent

Parameters

Returns WidgetComponentBase

Remarks

Throws

getComponents

Returns WidgetComponentBase[]

Remarks

Throws

setStateChangeEvent

Parameters

Returns void

Class Widget`Beta`

`Beta`bindPositionToBlockCursor

`Beta`collisionOffset

`Beta`collisionRadius

`Beta`location

`Beta`lockPositionToSurface

`Readonly` `Beta`selectable

`Beta`selected

`Beta`showBoundingBox

`Beta`showCollisionRadius

`Beta`snapToBlockLocation

`Beta`visible