Class RelativeVolumeListBlockVolume

Base type for BlockVolumes.

Hierarchy (View Summary)

BlockVolumeBase
- RelativeVolumeListBlockVolume

Index

Constructors

constructor

new RelativeVolumeListBlockVolume(
origin?: Vector3,
): RelativeVolumeListBlockVolume
Parameters
- Optionalorigin: Vector3
Returns RelativeVolumeListBlockVolume
Overrides BlockVolumeBase.constructor
- Defined in @minecraft/server-editor.d.ts:4687

Properties

`Readonly`isEmpty

isEmpty: boolean

`Optional` `World mutation`origin

origin?: Vector3

Remarks

`Readonly`volumeCount

volumeCount: number

Methods

add

add(
    toAdd:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
World mutation
Parameters
- toAdd:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:4693

clear

clear(): void
World mutation
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:4706

clone

clone(): RelativeVolumeListBlockVolume
Returns RelativeVolumeListBlockVolume
- Defined in @minecraft/server-editor.d.ts:4707

getBlockLocationIterator

getBlockLocationIterator(): BlockLocationIterator
Returns BlockLocationIterator

Remarks
Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume
Inherited from BlockVolumeBase.getBlockLocationIterator
- Defined in @minecraft/server.d.ts:6575

getBoundingBox

getBoundingBox(): BlockBoundingBox
Beta
Returns BlockBoundingBox

Remarks
Return a BlockBoundingBox object which represents the validated min and max coordinates of the volume

Throws
Inherited from BlockVolumeBase.getBoundingBox
- Defined in @minecraft/server.d.ts:6584

getCapacity

getCapacity(): number
Returns number

Remarks
Return the capacity (volume) of the BlockVolume (WDH)
Inherited from BlockVolumeBase.getCapacity
- Defined in @minecraft/server.d.ts:6590

getClosest

getClosest(count: number, location: Vector3): Vector3[]
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
ArgumentOutOfBoundsError
Inherited from BlockVolumeBase.getClosest
- Defined in @minecraft/server.d.ts:6603

getFarthest

getFarthest(count: number, location: Vector3): Vector3[]
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
ArgumentOutOfBoundsError
Inherited from BlockVolumeBase.getFarthest
- Defined in @minecraft/server.d.ts:6616

getMax

getMax(): Vector3
Returns Vector3

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

Throws
Inherited from BlockVolumeBase.getMax
- Defined in @minecraft/server.d.ts:6624

getMin

getMin(): Vector3
Returns Vector3

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

Throws
Inherited from BlockVolumeBase.getMin
- Defined in @minecraft/server.d.ts:6632

getSpan

getSpan(): Vector3
Returns Vector3

Remarks
Get a Vector3 object where each component represents the number of blocks along that axis
Inherited from BlockVolumeBase.getSpan
- Defined in @minecraft/server.d.ts:6639

getVolumeList

getVolumeList(): BlockVolume[]
World mutation
Returns BlockVolume[]

Remarks
- Defined in @minecraft/server-editor.d.ts:4713

hasAdjacent

hasAdjacent(location: Vector3, normalizedOffset: Vector3): boolean
Parameters
- location: Vector3
- normalizedOffset: Vector3
Returns boolean
- Defined in @minecraft/server-editor.d.ts:4714

isInside

isInside(location: Vector3): boolean
Parameters
- location: Vector3
Returns boolean

Remarks
Check to see if a given world block location is inside a BlockVolume
Inherited from BlockVolumeBase.isInside
- Defined in @minecraft/server.d.ts:6646

moveTo

moveTo(location: Vector3): void
World mutation
Parameters
- location: Vector3
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:4720

remove

remove(
    toRemove:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
World mutation
Parameters
- toRemove:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:4726

set

set(
    toSet:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
World mutation
Parameters
- toSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
Returns void

Remarks
- Defined in @minecraft/server-editor.d.ts:4739

translate

translate(offset: Vector3): void
World mutation
Parameters
- offset: Vector3
Returns void

Remarks
Overrides BlockVolumeBase.translate
- Defined in @minecraft/server-editor.d.ts:4752

Class RelativeVolumeListBlockVolume

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RelativeVolumeListBlockVolume

Properties

ReadonlyisEmpty

Optional World mutationorigin

Remarks

ReadonlyvolumeCount

Methods

add

Parameters

Returns void

Remarks

clear

Returns void

Remarks

clone

Returns RelativeVolumeListBlockVolume

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

`Readonly`isEmpty

`Optional` `World mutation`origin

`Readonly`volumeCount