Class Structure

Readonlyid

Readonlysize

getBlockPermutation

• getBlockPermutation(location: Vector3): BlockPermutation

  Parameters

  • location: Vector3

    The block location relative to the Structure's origin.

  Returns BlockPermutation

  Returns a BlockPermutation. Returns undefined if a block does not exist at the given location.

  Remarks

  Returns a BlockPermutation representing the block contained within the Structure at the given location.

  Throws

  Throws if the location is outside the structure's bounds. Throws if the Structure has been deleted.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

getIsWaterlogged

• getIsWaterlogged(location: Vector3): boolean

  Parameters

  • location: Vector3

    The block location relative to the Structure's origin.

  Returns boolean

  Returns whether the block at the given location is waterlogged. Returns false if a block does not exist at the given location.

  Remarks

  Returns whether the block at the given location is waterlogged.

  Throws

  Throws if the location is outside the structure's bounds. Throws if the Structure has been deleted.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

isValid

• isValid(): boolean

  Returns boolean

  Returns whether the Structure is valid.

  Remarks

  Returns whether the Structure is valid. The Structure may become invalid if it is deleted.