Class WidgetComponentVolumeOutline

Hierarchy (View Summary)

WidgetComponentBase
- WidgetComponentVolumeOutline

Properties

`Readonly`componentType

componentType: WidgetComponentType

Throws

This property can throw when used.

InvalidWidgetComponentError

`World mutation`highlightHullColor

highlightHullColor: RGBA

Remarks

`World mutation`highlightOutlineColor

highlightOutlineColor: RGBA

Remarks

`World mutation`hullColor

hullColor: RGBA

Remarks

`Readonly`location

location: Vector3

Throws

This property can throw when used.

InvalidWidgetComponentError

`World mutation`lockToSurface

lockToSurface: boolean

Remarks

`World mutation`mirror

mirror: StructureMirrorAxis

Remarks

`Readonly`name

name: string

Throws

This property can throw when used.

InvalidWidgetComponentError

`World mutation`normalizedOrigin

normalizedOrigin: Vector3

Remarks

`World mutation`offset

offset: Vector3

Remarks

`World mutation`outlineColor

outlineColor: RGBA

Remarks

`World mutation`rotation

rotation: StructureRotation

Remarks

`World mutation`showHighlightOutline

showHighlightOutline: boolean

Remarks

`World mutation`showOutline

showOutline: boolean

Remarks

`Readonly`transformedWorldVolume

transformedWorldVolume: BlockVolume

Throws

This property can throw when used.

InvalidWidgetComponentError

`Readonly`valid

valid: boolean

visible

visible: boolean

`World mutation`volumeOffset

volumeOffset: Vector3

Remarks

`Readonly`widget

widget: Widget

Throws

This property can throw when used.

InvalidWidgetComponentError

Methods

delete

delete(): void
World mutation
Returns void
Remarks
Throws
This function can throw errors.

InvalidWidgetComponentError
Inherited from WidgetComponentBase.delete
- Defined in @minecraft/server-editor.d.ts:4625

getVolume

getVolume(): RelativeVolumeListBlockVolume
World mutation
Returns RelativeVolumeListBlockVolume
Remarks
Throws
This function can throw errors.

InvalidWidgetComponentError
- Defined in @minecraft/server-editor.d.ts:5102

setVolume

setVolume(
    volumeToSet?:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
World mutation
Parameters
- OptionalvolumeToSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
Throws
This function can throw errors.

InvalidWidgetComponentError
- Defined in @minecraft/server-editor.d.ts:5111