Class RelativeVolumeListBlockVolume

Base type for BlockVolumes.

Source

export class BlockVolumeBase {
    private constructor();
    getBlockLocationIterator(): BlockLocationIterator;
    getCapacity(): number;
    getMax(): Vector3;
    getMin(): Vector3;
    getSpan(): Vector3;
    isInside(location: Vector3): boolean;
    translate(delta: Vector3): void;
}

Hierarchy (View Summary)

BlockVolumeBase
- RelativeVolumeListBlockVolume

Index

Constructors

constructor

new RelativeVolumeListBlockVolume(
origin?: Vector3,
): RelativeVolumeListBlockVolume
Parameters
- Optionalorigin: Vector3
Returns RelativeVolumeListBlockVolume
Overrides BlockVolumeBase.constructor

Properties

`Readonly`isEmpty

isEmpty: boolean

`Optional`origin

origin?: Vector3

Remarks

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

World Ready

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

`Readonly`volumeCount

volumeCount: number

Methods

add

add(
    toAdd:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- toAdd:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in restricted-execution mode.

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

clear

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

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

getBlockLocationIterator

getBlockLocationIterator(): BlockLocationIterator
Returns BlockLocationIterator
Remarks
Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume

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

Inherited from BlockVolumeBase.getBlockLocationIterator

getBoundingBox

getBoundingBox(): BlockBoundingBox
Beta
Returns BlockBoundingBox
Remarks
Return a BlockBoundingBox object which represents the validated min and max coordinates of the volume

Throws
This function can throw errors.

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

Inherited from minecraftserver.BlockVolumeBase.getBoundingBox

getCapacity

getCapacity(): number
Returns number
Remarks
Return the capacity (volume) of the BlockVolume (WDH)

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

Inherited from BlockVolumeBase.getCapacity

getMax

getMax(): Vector3
Returns Vector3
Remarks
Get the largest corner position of the volume (guaranteed to be >= min)

Throws
This function can throw errors.

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

Inherited from BlockVolumeBase.getMax

getMin

getMin(): Vector3
Returns Vector3
Remarks
Get the smallest corner position of the volume (guaranteed to be <= max)

Throws
This function can throw errors.

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

Inherited from BlockVolumeBase.getMin

getSpan

getSpan(): Vector3
Returns Vector3
Remarks
Get a Vector3 object where each component represents the number of blocks along that axis

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

Inherited from BlockVolumeBase.getSpan

getVolumeList

getVolumeList(): BlockVolume[]
Returns BlockVolume[]
Remarks
This function can't be called in restricted-execution mode.

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

hasAdjacent

hasAdjacent(location: Vector3, normalizedOffset: Vector3): boolean
Parameters
- location: Vector3
- normalizedOffset: Vector3
Returns boolean

isInside

isInside(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean
Remarks
Check to see if a given world block location is inside a BlockVolume

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

Inherited from BlockVolumeBase.isInside

moveTo

moveTo(location: Vector3): void
Parameters
- location: Vector3
Returns void
Remarks
This function can't be called in restricted-execution mode.

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

remove

remove(
    toRemove:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- toRemove:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in restricted-execution mode.

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

set

set(
    toSet:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Parameters
- toSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in restricted-execution mode.

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

translate

translate(offset: Vector3): void
Parameters
- offset: Vector3
Returns void
Remarks
This function can't be called in restricted-execution mode.

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

Overrides BlockVolumeBase.translate

Class RelativeVolumeListBlockVolume

Source

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RelativeVolumeListBlockVolume

Properties

ReadonlyisEmpty

Optionalorigin

Remarks

World Ready

ReadonlyvolumeCount

Methods

add

Parameters

Returns void

Remarks

World Ready

clear

Returns void

Remarks

World Ready

getBlockLocationIterator

Returns BlockLocationIterator

Remarks

World Ready

getBoundingBox

Returns BlockBoundingBox

Remarks

Throws

World Ready

getCapacity

Returns number

Remarks

World Ready

getMax

Returns Vector3

Remarks

Throws

World Ready

getMin

Returns Vector3

Remarks

Throws

World Ready

getSpan

Returns Vector3

Remarks

World Ready

getVolumeList

Returns BlockVolume[]

Remarks

World Ready

hasAdjacent

Parameters

Returns boolean

isInside

Parameters

Returns boolean

Remarks

World Ready

moveTo

Parameters

Returns void

Remarks

World Ready

remove

Parameters

Returns void

Remarks

World Ready

set

Parameters

Returns void

Remarks

`Readonly`isEmpty

`Optional`origin

`Readonly`volumeCount