类 ListBlockVolume实验性

Volume composed of an unordered container of unique block locations.

层级 (查看层级一览)

构造函数

constructor

方法

add getBlockLocationIterator getBoundingBox getCapacity 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.

方法

add

  • add(locations: Vector3[]): void
  • 实验性

    参数

    • locations: Vector3[]

      Array of block locations to be inserted into container.

    返回 void

    备注

    Insert block locations into container.

getBlockLocationIterator

getBoundingBox

  • getBoundingBox(): BoundingBox
  • 实验性

    返回 BoundingBox

    备注

    返回一个 BoundingBox 对象，表示该体积经过验证的最小和最大坐标。

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

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    This function can throw errors.

getCapacity

  • getCapacity(): number
  • 实验性

    返回 number

    备注

    返回 BlockVolume 的容量（体积）（宽深高）。

    Return the capacity (volume) of the BlockVolume (WDH)

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

getMax

  • getMax(): Vector3
  • 实验性

    返回 Vector3

    备注

    获取体积的最大角位置（保证 >= 最小值）。

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

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    This function can throw errors.

getMin

  • getMin(): Vector3
  • 实验性

    返回 Vector3

    备注

    获取体积的最小角位置（保证 <= 最大值）。

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

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    This function can throw errors.

getSpan

  • getSpan(): Vector3
  • 实验性

    返回 Vector3

    备注

    获取一个 Vector3 对象，其中每个分量表示沿该轴的方块数量。

    Get a Vector3 object where each component represents the number of blocks along that axis

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

isInside

  • isInside(location: Vector3): boolean
  • 实验性

    参数

    返回 boolean

    备注

    检查给定的世界方块位置是否在 BlockVolume 内。

    Check to see if a given world block location is inside a BlockVolume

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

remove

  • remove(locations: Vector3[]): void
  • 实验性

    参数

    • locations: Vector3[]

      Array of block locations to be removed from container.

    返回 void

    备注

    Remove block locations from container.

translate

  • translate(delta: Vector3): void
  • 实验性

    参数

    • delta: Vector3

      移动的方块数量。

      Amount of blocks to move by

    返回 void

    备注

    按指定的量移动 BlockVolume。

    Move a BlockVolume by a specified amount

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

显示设置

成员可见性

目录

构造函数
方法