类 ListBlockVolume

Volume composed of an unordered container of unique block locations.

层级 (查看层级一览)

BlockVolumeBase
- ListBlockVolume

索引

构造函数

方法

add getBlockLocationIterator getBoundingBox getCapacity getClosest getFarthest getMax getMin getSpan isInside remove translate

构造函数

constructor

new ListBlockVolume(locations: Vector3[]): ListBlockVolume
参数
- locations: Vector3[]
  Initial array of block locations that ListBlockVolume will be constructed with.
返回 ListBlockVolume

备注
Creates a new instance of ListBlockVolume.
重写了 BlockVolumeBase.constructor
- 定义于 @minecraft/server.d.ts:16012

方法

add

add(locations: Vector3[]): void
参数
- locations: Vector3[]
  Array of block locations to be inserted into container.
返回 void

备注
Insert block locations into container.
- 定义于 @minecraft/server.d.ts:16020

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

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

remove

remove(locations: Vector3[]): void
参数
- locations: Vector3[]
  Array of block locations to be removed from container.
返回 void

备注
Remove block locations from container.
- 定义于 @minecraft/server.d.ts:16028

translate

translate(delta: Vector3): void
参数
- delta: Vector3
  Amount of blocks to move by
返回 void

备注
Move a BlockVolume by a specified amount
继承自 BlockVolumeBase.translate
- 定义于 @minecraft/server.d.ts:6819