Class Structure

Readonlysize

getBlockPermutation

• getBlockPermutation(location: Vector3): BlockPermutation

  Parameters

  • location: Vector3

  Returns BlockPermutation

  Throws

  This function can throw errors.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

  World Ready

  This function can't be called in early-execution mode.

getIsWaterlogged

• getIsWaterlogged(location: Vector3): boolean

  Parameters

  • location: Vector3

  Returns boolean

  Throws

  This function can throw errors.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

  World Ready

  This function can't be called in early-execution mode.

saveAs

• saveAs(identifier: string, saveMode?: StructureSaveMode): Structure

  Parameters

  • identifier: string
  • OptionalsaveMode: StructureSaveMode

  Returns Structure

  Remarks

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  minecraftcommon.EngineError

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

  World Ready

  This function can't be called in early-execution mode.

saveToWorld

• saveToWorld(): void

  Returns void

  Remarks

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  InvalidStructureError

  World Ready

  This function can't be called in early-execution mode.

setBlockPermutation

• setBlockPermutation(
      location: Vector3,
      blockPermutation?: BlockPermutation,
      waterlogged?: boolean,
  ): void

  Parameters

  • location: Vector3
  • OptionalblockPermutation: BlockPermutation
  • Optionalwaterlogged: boolean

  Returns void

  Remarks

  This function can't be called in restricted-execution mode.

  Throws

  This function can throw errors.

  minecraftcommon.InvalidArgumentError

  InvalidStructureError

  World Ready

  This function can't be called in early-execution mode.