Class SelectionContainerVolume

Hierarchy (View Summary)

SelectionContainerBase
- SelectionContainerVolume

Index

Constructors

Properties

isEmpty volumeCount

Methods

add clear get getBoundingBox moveTo remove set translate

Constructors

`Private`constructor

new SelectionContainerVolume(): SelectionContainerVolume
Returns SelectionContainerVolume
Overrides SelectionContainerBase.constructor

Properties

`Readonly`isEmpty

isEmpty: boolean

`Readonly`volumeCount

volumeCount: number

Methods

add

add(
    volume:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- volume:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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

clear

clear(): void
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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

get

get(): RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume

getBoundingBox

getBoundingBox(): BlockBoundingBox
Returns BlockBoundingBox
Throws
This function can throw errors.

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

moveTo

moveTo(location: Vector3): void
Parameters
- location: Vector3
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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

remove

remove(
    volume:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- volume:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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

set

set(
    volume:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- volume:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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

translate

translate(offset: Vector3): void
Parameters
- offset: Vector3
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

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