#Class: Widget experimental

Beta

#Properties

#bindPositionToBlockCursor

bindPositionToBlockCursor: boolean

World Mutation Beta

#Remarks

---

#collisionOffset

collisionOffset: Vector3

World Mutation Beta

#Remarks

---

#collisionRadius

collisionRadius: number

World Mutation Beta

#Remarks

---

#collisionType

collisionType: WidgetCollisionType

World Mutation Beta

#Remarks

---

#dimensionId?

optional dimensionId?: string

Beta

---

#group

readonly group: WidgetGroup

Beta

#Throws

This property can throw when used.

InvalidWidgetError

---

#ignoreEditorModeVisibilityOverride

ignoreEditorModeVisibilityOverride: boolean

World Mutation Beta

#Remarks

---

#location

location: Vector3

World Mutation Beta

#Remarks

---

#lockPositionToSurface

lockPositionToSurface: boolean

World Mutation Beta

#Remarks

---

#selectable

readonly selectable: boolean

Beta

#Throws

This property can throw when used.

InvalidWidgetError

---

#selected

selected: boolean

Beta

---

#showBoundingBox

showBoundingBox: boolean

Beta

---

#showCollisionRadius

showCollisionRadius: boolean

Beta

---

#snapToBlockLocation

snapToBlockLocation: boolean

World Mutation Beta

#Remarks

---

#visible

visible: boolean

Beta

---

#widgetName

readonly widgetName: string

Beta

#Methods

#addBoundingBox()

addBoundingBox(componentName, size, options?): WidgetComponentBoundingBox

World Mutation Beta

#Parameters

#componentName

string

#size

Vector3

#options?

WidgetComponentBoundingBoxOptions

#Returns

WidgetComponentBoundingBox

#Remarks

#Throws

This function can throw errors.

---

#addClipboardComponent()

addClipboardComponent(componentName, clipboardItem?, options?): WidgetComponentClipboard

World Mutation Beta

#Parameters

#componentName

string

#clipboardItem?

ClipboardItem | EditorStructure

#options?

WidgetComponentClipboardOptions

#Returns

WidgetComponentClipboard

#Remarks

#Throws

This function can throw errors.

---

#addEntityComponent()

addEntityComponent(componentName, actorNameId, options?): WidgetComponentEntity

World Mutation Beta

#Parameters

#componentName

string

#actorNameId

string

#options?

WidgetComponentEntityOptions

#Returns

WidgetComponentEntity

#Remarks

#Throws

This function can throw errors.

---

#addGizmoComponent()

addGizmoComponent(componentName, options?): WidgetComponentGizmo

World Mutation Beta

#Parameters

#componentName

string

#options?

WidgetComponentGizmoOptions

#Returns

WidgetComponentGizmo

#Remarks

#Throws

This function can throw errors.

---

#addGridComponent()

addGridComponent(componentName, options?): WidgetComponentGrid

World Mutation Beta

#Parameters

#componentName

string

#options?

WidgetComponentGridOptions

#Returns

WidgetComponentGrid

#Remarks

#Throws

This function can throw errors.

---

#addGuideComponent()

addGuideComponent(componentName, options?): WidgetComponentGuide

World Mutation Beta

#Parameters

#componentName

string

#options?

WidgetComponentGuideOptions

#Returns

WidgetComponentGuide

#Remarks

#Throws

This function can throw errors.

---

#addRenderPlaneComponent()

addRenderPlaneComponent(componentName, options?): WidgetComponentRenderPlane

World Mutation Beta

#Parameters

#componentName

string

#options?

WidgetComponentRenderPlaneOptions

#Returns

WidgetComponentRenderPlane

#Remarks

#Throws

This function can throw errors.

---

#addRenderPrimitiveComponent()

addRenderPrimitiveComponent(componentName, primitiveType, options?): WidgetComponentRenderPrimitive

World Mutation Beta

#Parameters

#componentName

string

#primitiveType

WidgetComponentRenderPrimitiveTypeAxialSphere | WidgetComponentRenderPrimitiveTypeBox | WidgetComponentRenderPrimitiveTypeCone | WidgetComponentRenderPrimitiveTypeCuboid | WidgetComponentRenderPrimitiveTypeCylinder | WidgetComponentRenderPrimitiveTypeDisc | WidgetComponentRenderPrimitiveTypeEllipsoid | WidgetComponentRenderPrimitiveTypeLine | WidgetComponentRenderPrimitiveTypePyramid | WidgetComponentRenderPrimitiveTypeWireframeMesh

#options?

WidgetComponentRenderPrimitiveOptions

#Returns

WidgetComponentRenderPrimitive

#Remarks

#Throws

This function can throw errors.

---

#addSplineComponent()

addSplineComponent(componentName, options?): WidgetComponentSpline

World Mutation Beta

#Parameters

#componentName

string

#options?

WidgetComponentSplineOptions

#Returns

WidgetComponentSpline

#Remarks

#Throws

This function can throw errors.

---

#addTextComponent()

addTextComponent(componentName, label, options?): WidgetComponentText

World Mutation Beta

#Parameters

#componentName

string

#label

string

#options?

WidgetComponentTextOptions

#Returns

WidgetComponentText

#Remarks

#Throws

This function can throw errors.

---

#addVolumeOutline()

addVolumeOutline(componentName, volume?, options?): WidgetComponentVolumeOutline

World Mutation Beta

#Parameters

#componentName

string

#volume?

any

#options?

WidgetComponentVolumeOutlineOptions

#Returns

WidgetComponentVolumeOutline

#Remarks

#Throws

This function can throw errors.

---

#delete()

delete(): void

World Mutation Beta

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#deleteComponent()

deleteComponent(componentOrName): void

World Mutation Beta

#Parameters

#componentOrName

string | WidgetComponentBase

#Returns

void

#Remarks

#Throws

This function can throw errors.

---

#getComponent()

getComponent(componentName): WidgetComponentBase

World Mutation Beta

#Parameters

#componentName

string

#Returns

WidgetComponentBase

#Remarks

#Throws

This function can throw errors.

---

#getComponents()

getComponents(): WidgetComponentBase[]

World Mutation Beta

#Returns

WidgetComponentBase[]

#Remarks

#Throws

This function can throw errors.

InvalidWidgetError

---

#setStateChangeEvent()

setStateChangeEvent(eventFunction?): void

World Mutation Beta

#Parameters

#eventFunction?

(arg0) => void

#Returns

void

#Remarks

#Throws

This function can throw errors.

InvalidWidgetError