Class RelativeVolumeListBlockVolume`Beta`

Hierarchy

BlockVolumeBase
- RelativeVolumeListBlockVolume

Index

Constructors

Properties

Methods

add clear getBlockLocationIterator getBoundingBox getCapacity getClosest getFarthest 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:4206

Properties

`Readonly` `Beta`isEmpty

isEmpty: boolean

`Optional` `Beta`origin

origin?: Vector3

Remarks

This property can't be edited in restricted-execution 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 restricted-execution mode.
- Defined in tmp/package/index.d.ts:4212

clear

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

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:6533

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.
Inherited from minecraftserver.BlockVolumeBase.getBoundingBox
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:6542

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:6548

getClosest

getClosest(count: number, location: Vector3): Vector3[]
Beta
Parameters
- count: number
  Number of closest positions to return
- location: Vector3
  Position to measure distance from
Returns Vector3[]
Remarks
Returns a list of block positions within the volume that are closest to a given location, sorted by distance (nearest first)

Throws
This function can throw errors.

minecraftcommon.ArgumentOutOfBoundsError
Inherited from minecraftserver.BlockVolumeBase.getClosest
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:6564

getFarthest

getFarthest(count: number, location: Vector3): Vector3[]
Beta
Parameters
- count: number
  Number of farthest positions to return
- location: Vector3
  Position to measure distance from
Returns Vector3[]
Remarks
Returns a list of block positions within the volume that are farthest from a given location, sorted by distance (farthest first)

Throws
This function can throw errors.

minecraftcommon.ArgumentOutOfBoundsError
Inherited from minecraftserver.BlockVolumeBase.getFarthest
- Defined in tmp/package/node_modules/@minecraft/server/index.d.ts:6580

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:6588

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:6596

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:6603

getVolumeList

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

hasAdjacent

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

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:6610

moveTo

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

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 restricted-execution mode.
- Defined in tmp/package/index.d.ts:4244

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 restricted-execution mode.
- Defined in tmp/package/index.d.ts:4257

translate

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

Class RelativeVolumeListBlockVolumeBeta

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RelativeVolumeListBlockVolume

Properties

Readonly BetaisEmpty

Optional Betaorigin

Remarks

Readonly BetavolumeCount

Methods

add

Parameters

Returns void

Remarks

clear

Returns void

Remarks

getBlockLocationIterator

Returns BlockLocationIterator

Remarks

getBoundingBox

Returns BlockBoundingBox

Remarks

Throws

getCapacity

Returns number

Remarks

getClosest

Parameters

Returns Vector3[]

Remarks

Throws

getFarthest

Parameters

Returns Vector3[]

Remarks

Throws

getMax

Returns Vector3

Remarks

Throws

getMin

Returns Vector3

Remarks

Throws

getSpan

Returns Vector3

Remarks

getVolumeList

Returns BlockVolume[]

Remarks

hasAdjacent

Parameters

Returns boolean

isInside

Parameters

Returns boolean

Remarks

moveTo

Parameters

Returns void

Remarks

remove

Parameters

Returns void

Remarks

set

Parameters

Returns void

Remarks

translate

Parameters

Returns void

Remarks

Class RelativeVolumeListBlockVolume`Beta`

`Readonly` `Beta`isEmpty

`Optional` `Beta`origin

`Readonly` `Beta`volumeCount