Class WidgetComponentVolumeOutline

Hierarchy (View Summary)

WidgetComponentBase
- WidgetComponentVolumeOutline

Constructors

`Private`constructor

new WidgetComponentVolumeOutline(): WidgetComponentVolumeOutline
Returns WidgetComponentVolumeOutline
Overrides WidgetComponentBase.constructor

Properties

`Readonly`componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

highlightHullColor

highlightHullColor: RGBA

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

highlightOutlineColor

highlightOutlineColor: RGBA

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

hullColor

hullColor: RGBA

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

`Readonly`location

location: Vector3

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

lockToSurface

lockToSurface: boolean

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

mirror

mirror: StructureMirrorAxis

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

`Readonly`name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

normalizedOrigin

normalizedOrigin: Vector3

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

offset

offset: Vector3

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

outlineColor

outlineColor: RGBA

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

rotation

rotation: StructureRotation

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

showHighlightOutline

showHighlightOutline: boolean

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

showOutline

showOutline: boolean

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

`Readonly`transformedWorldVolume

transformedWorldVolume: BlockVolume

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

`Readonly`valid

valid: boolean

visible

visible: boolean

volumeOffset

volumeOffset: Vector3

Remarks

Privilege

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

World Ready

This property can't be read in early-execution mode.

`Readonly`widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

World Ready

This property can't be read in early-execution mode.

Methods

delete

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

Throws
This function can throw errors.

InvalidWidgetComponentError

World Ready
This function can't be called in early-execution mode.

Inherited from WidgetComponentBase.delete

getVolume

getVolume(): RelativeVolumeListBlockVolume | undefined
Returns RelativeVolumeListBlockVolume | undefined
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidWidgetComponentError

World Ready
This function can't be called in early-execution mode.

setVolume

setVolume(
    volumeToSet?:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- OptionalvolumeToSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
Privilege
no-restricted-execution - This function can't be called in restricted-execution mode.

Throws
This function can throw errors.

InvalidWidgetComponentError

World Ready
This function can't be called in early-execution mode.

Class WidgetComponentVolumeOutline

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Returns WidgetComponentVolumeOutline

Properties

ReadonlycomponentType

Throws

World Ready

highlightHullColor

Remarks

Privilege

World Ready

highlightOutlineColor

Remarks

Privilege

World Ready

hullColor

Remarks

Privilege

World Ready

Readonlylocation

Throws

World Ready

lockToSurface

Remarks

Privilege

World Ready

mirror

Remarks

Privilege

World Ready

Readonlyname

Throws

World Ready

normalizedOrigin

Remarks

Privilege

World Ready

offset

Remarks

Privilege

World Ready

outlineColor

Remarks

Privilege

World Ready

rotation

Remarks

Privilege

World Ready

showHighlightOutline

Remarks

Privilege

World Ready

showOutline

Remarks

Privilege

World Ready

ReadonlytransformedWorldVolume

Throws

World Ready

Readonlyvalid

visible

volumeOffset

Remarks

Privilege

World Ready

Readonlywidget

Throws

World Ready

Methods

delete

Returns void

Remarks

Privilege

`Private`constructor

`Readonly`componentType

`Readonly`location

`Readonly`name

`Readonly`transformedWorldVolume

`Readonly`valid

`Readonly`widget