Class RelativeVolumeListBlockVolume`Beta`

Hierarchy

BlockVolumeBase
- RelativeVolumeListBlockVolume

Index

Constructors

Properties

isEmpty origin? volumeCount

Methods

add clear getBlockLocationIterator getBoundingBox getCapacity getMax getMin getSpan getVolumeList hasAdjacent isInside moveTo remove set translate

Constructors

constructor

new RelativeVolumeListBlockVolume(
origin?: Vector3,
): RelativeVolumeListBlockVolume
Beta
Parameters
- Optionalorigin: Vector3
Returns RelativeVolumeListBlockVolume
Overrides minecraftserver.BlockVolumeBase.constructor
- Defined in tmp/package/index.d.ts:2833

Properties

`Readonly` `Beta`isEmpty

isEmpty: boolean

`Optional` `Beta`origin

origin?: Vector3

Remarks

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

`Readonly` `Beta`volumeCount

volumeCount: number

Methods

add

add(
    toAdd:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Beta
Parameters
- toAdd:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:2839

clear

clear(): void
Beta
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:2852

getBlockLocationIterator

getBlockLocationIterator(): BlockLocationIterator
Beta
Returns BlockLocationIterator
Remarks
Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume
Inherited from minecraftserver.BlockVolumeBase.getBlockLocationIterator
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5020

getBoundingBox

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

Throws
This function can throw errors.
Inherited from minecraftserver.BlockVolumeBase.getBoundingBox
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5029

getCapacity

getCapacity(): number
Beta
Returns number
Remarks
Return the capacity (volume) of the BlockVolume (WDH)
Inherited from minecraftserver.BlockVolumeBase.getCapacity
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5035

getMax

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

Throws
This function can throw errors.
Inherited from minecraftserver.BlockVolumeBase.getMax
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5043

getMin

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

Throws
This function can throw errors.
Inherited from minecraftserver.BlockVolumeBase.getMin
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5051

getSpan

getSpan(): Vector3
Beta
Returns Vector3
Remarks
Get a Vector3 object where each component represents the number of blocks along that axis
Inherited from minecraftserver.BlockVolumeBase.getSpan
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5058

getVolumeList

getVolumeList(): BlockVolume[]
Beta
Returns BlockVolume[]
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:2858

hasAdjacent

hasAdjacent(location: Vector3, normalizedOffset: Vector3): boolean
Beta
Parameters
- location: Vector3
- normalizedOffset: Vector3
Returns boolean
- Defined in tmp/package/index.d.ts:2859

isInside

isInside(location: Vector3): boolean
Beta
Parameters
- location: Vector3
Returns boolean
Remarks
Check to see if a given world block location is inside a BlockVolume
Inherited from minecraftserver.BlockVolumeBase.isInside
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:5065

moveTo

moveTo(location: Vector3): void
Beta
Parameters
- location: Vector3
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:2865

remove

remove(
    toRemove:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Beta
Parameters
- toRemove:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:2871

set

set(
    toSet:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
Beta
Parameters
- toSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void
Remarks
This function can't be called in read-only mode.
- Defined in tmp/package/index.d.ts:2884

translate

translate(offset: Vector3): void
Beta
Parameters
- offset: Vector3
Returns void
Remarks
This function can't be called in read-only mode.
Overrides minecraftserver.BlockVolumeBase.translate
- Defined in tmp/package/index.d.ts:2897