类 RelativeVolumeListBlockVolume

Base type for BlockVolumes.

层级 (查看层级一览)

BlockVolumeBase
- RelativeVolumeListBlockVolume

索引

构造函数

属性

isEmpty origin? volumeCount

方法

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

构造函数

constructor

new RelativeVolumeListBlockVolume(
origin?: Vector3,
): RelativeVolumeListBlockVolume
参数
- 可选origin: Vector3
返回 RelativeVolumeListBlockVolume
重写了 BlockVolumeBase.constructor
- 定义于 @minecraft/server-editor.d.ts:4687

属性

`只读`isEmpty

isEmpty: boolean

`可选` `世界修改`origin

origin?: Vector3

备注

`只读`volumeCount

volumeCount: number

方法

add

add(
    toAdd:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
世界修改
参数
- toAdd:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
返回 void

备注
- 定义于 @minecraft/server-editor.d.ts:4693

clear

clear(): void
世界修改
返回 void

备注
- 定义于 @minecraft/server-editor.d.ts:4706

clone

clone(): RelativeVolumeListBlockVolume
返回 RelativeVolumeListBlockVolume
- 定义于 @minecraft/server-editor.d.ts:4707

getBlockLocationIterator

getBlockLocationIterator(): BlockLocationIterator
返回 BlockLocationIterator

备注
Fetch a BlockLocationIterator that represents all of the block world locations within the specified volume
继承自 BlockVolumeBase.getBlockLocationIterator
- 定义于 @minecraft/server.d.ts:6740

getBoundingBox

getBoundingBox(): BlockBoundingBox
实验性
返回 BlockBoundingBox

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

抛出
继承自 BlockVolumeBase.getBoundingBox
- 定义于 @minecraft/server.d.ts:6749

getCapacity

getCapacity(): number
返回 number

备注
Return the capacity (volume) of the BlockVolume (WDH)
继承自 BlockVolumeBase.getCapacity
- 定义于 @minecraft/server.d.ts:6755

getClosest

getClosest(count: number, location: Vector3): Vector3[]
参数
- count: number
  Number of closest positions to return
- location: Vector3
  Position to measure distance from
返回 Vector3[]

备注
Returns a list of block positions within the volume that are closest to a given location, sorted by distance (nearest first)

抛出
ArgumentOutOfBoundsError
继承自 BlockVolumeBase.getClosest
- 定义于 @minecraft/server.d.ts:6768

getFarthest

getFarthest(count: number, location: Vector3): Vector3[]
参数
- count: number
  Number of farthest positions to return
- location: Vector3
  Position to measure distance from
返回 Vector3[]

备注
Returns a list of block positions within the volume that are farthest from a given location, sorted by distance (farthest first)

抛出
ArgumentOutOfBoundsError
继承自 BlockVolumeBase.getFarthest
- 定义于 @minecraft/server.d.ts:6781

getMax

getMax(): Vector3
返回 Vector3

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

抛出
继承自 BlockVolumeBase.getMax
- 定义于 @minecraft/server.d.ts:6789

getMin

getMin(): Vector3
返回 Vector3

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

抛出
继承自 BlockVolumeBase.getMin
- 定义于 @minecraft/server.d.ts:6797

getSpan

getSpan(): Vector3
返回 Vector3

备注
Get a Vector3 object where each component represents the number of blocks along that axis
继承自 BlockVolumeBase.getSpan
- 定义于 @minecraft/server.d.ts:6804

getVolumeList

getVolumeList(): BlockVolume[]
世界修改
返回 BlockVolume[]

备注
- 定义于 @minecraft/server-editor.d.ts:4713

hasAdjacent

hasAdjacent(location: Vector3, normalizedOffset: Vector3): boolean
参数
- location: Vector3
- normalizedOffset: Vector3
返回 boolean
- 定义于 @minecraft/server-editor.d.ts:4714

isInside

isInside(location: Vector3): boolean
参数
- location: Vector3
返回 boolean

备注
Check to see if a given world block location is inside a BlockVolume
继承自 BlockVolumeBase.isInside
- 定义于 @minecraft/server.d.ts:6811

moveTo

moveTo(location: Vector3): void
世界修改
参数
- location: Vector3
返回 void

备注
- 定义于 @minecraft/server-editor.d.ts:4720

remove

remove(
    toRemove:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
世界修改
参数
- toRemove:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
返回 void

备注
- 定义于 @minecraft/server-editor.d.ts:4726

set

set(
    toSet:
        | Vector3
        | Vector3[]
        | BlockVolume
        | BlockVolumeBase
        | RelativeVolumeListBlockVolume,
): void
世界修改
参数
- toSet:
      | Vector3
      | Vector3[]
      | BlockVolume
      | BlockVolumeBase
      | RelativeVolumeListBlockVolume
返回 void

备注
- 定义于 @minecraft/server-editor.d.ts:4739

translate

translate(offset: Vector3): void
世界修改
参数
- offset: Vector3
返回 void

备注
重写了 BlockVolumeBase.translate
- 定义于 @minecraft/server-editor.d.ts:4752