space_ex v0.3.0 SpaceEx.SpaceCenter.ResourceTransfer

Transfer resources between parts.

Link to this section Summary

Functions

The amount of the resource that has been transferred

Whether the transfer has completed

Start transferring a resource transfer between a pair of parts

Link to this section Functions

Link to this function amount(conn, this)

The amount of the resource that has been transferred.

Link to this function complete(conn, this)

Whether the transfer has completed.

Link to this function start(conn, fromPart, toPart, resource, maxAmount)

Start transferring a resource transfer between a pair of parts.

The transfer will move at most maxAmount units of the resource, depending on how much of the resource is available in the source part and how much storage is available in the destination part. Use SpaceEx.SpaceCenter.ResourceTransfer.complete/2 to check if the transfer is complete. Use SpaceEx.SpaceCenter.ResourceTransfer.amount/2 to see how much of the resource has been transferred.

  • fromPart — The part to transfer to.

  • toPart — The part to transfer from.

  • resource — The name of the resource to transfer.

  • maxAmount — The maximum amount of resource to transfer.