Class WidgetComponentVolumeOutline

Hierarchy

Constructors

constructor

Properties

componentType highlightHullColor highlightOutlineColor hullColor location lockToSurface mirror name normalizedOrigin offset outlineColor rotation showHighlightOutline showOutline transformedWorldVolume valid visible volumeOffset widget

Methods

delete getVolume setVolume

Constructors

Private constructor

Properties

Readonly componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

highlightHullColor

highlightHullColor: RGBA

Remarks

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

highlightOutlineColor

highlightOutlineColor: RGBA

Remarks

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

hullColor

hullColor: RGBA

Remarks

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

Readonly location

location: Vector3

Throws

This property can throw when used.

InvalidWidgetComponentError

lockToSurface

lockToSurface: boolean

Remarks

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

mirror

mirror: StructureMirrorAxis

Remarks

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

Readonly name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

normalizedOrigin

normalizedOrigin: Vector3

Remarks

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

offset

offset: Vector3

Remarks

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

outlineColor

outlineColor: RGBA

Remarks

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

rotation

rotation: StructureRotation

Remarks

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

showHighlightOutline

showHighlightOutline: boolean

Remarks

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

showOutline

showOutline: boolean

Remarks

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

Readonly transformedWorldVolume

transformedWorldVolume: BlockVolume

Throws

This property can throw when used.

InvalidWidgetComponentError

Readonly valid

valid: boolean

visible

visible: boolean

volumeOffset

volumeOffset: Vector3

Remarks

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

Readonly widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

Methods

delete

getVolume

setVolume

  • Parameters

    Returns void

    Remarks

    This function can't be called in read-only mode.

    Throws

    This function can throw errors.

    InvalidWidgetComponentError

Settings

Member Visibility

Theme

On This Page