Initial pass at relay detection. Not working yet.
Initial pass at relay detection. Not working yet.

--- a/AntennaRange.cs
+++ b/AntennaRange.cs
@@ -11,12 +11,15 @@
  * This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a
  * copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/
  * 
- * This software uses the ModuleManager library © 2013 ialdabaoth, used under a Creative Commons Attribution-ShareAlike 3.0 Uported License.
+ * This software uses the ModuleManager library © 2013 ialdabaoth, used under a Creative Commons Attribution-ShareAlike
+ * 3.0 Uported License.
+ * 
+ * This software uses code from the MuMechLib library, © 2013 r4m0n, used under the GNU GPL version 3.
  * 
  */
-
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using KSP;
 
 namespace AntennaRange
@@ -33,6 +36,10 @@
 	 * where D is the total transmission distance, P is the transmission power, and R is the data rate.
 	 * 
 	 * */
+
+	/*
+	 * Fields
+	 * */
 	public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter
 	{
 		// Stores the packetResourceCost as defined in the .cfg file.
@@ -44,63 +51,151 @@
 		// We don't have a Bard, so we're hiding Kerbin here.
 		protected CelestialBody _Kerbin;
 
-		// Returns the current distance to the center of Kerbin, which is totally where the Kerbals keep their radioes.
-		protected double transmitDistance
-		{
-			get
-			{
-				Vector3d KerbinPos = this._Kerbin.position;
-				Vector3d ActivePos = base.vessel.GetWorldPos3D();
-
-				return (ActivePos - KerbinPos).magnitude;
-			}
-		}
-
-		// Returns the maximum distance this module can transmit
-		public double maxTransmitDistance
-		{
-			get
-			{
-				return Math.Sqrt (this.maxPowerFactor) * this.nominalRange;
-			}
-		}
+		// Keep track of vessels with transmitters for relay purposes.
+		protected List<Vessel> _relayVessels;
+
+		// Sometimes we will need to communicate errors; this is how we do it.
+		protected ScreenMessage ErrorMsg;
+
+		// Let's make the error text pretty!
+		protected UnityEngine.GUIStyle ErrorStyle;
 
 		// The distance from Kerbin at which the antenna will perform exactly as prescribed by packetResourceCost
 		// and packetSize.
 		[KSPField(isPersistant = false)]
-		public double nominalRange = 1500000d;
+		public float nominalRange;
 
 		// The multiplier on packetResourceCost that defines the maximum power output of the antenna.  When the power
 		// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail.
 		[KSPField(isPersistant = false)]
-		public float maxPowerFactor = 8f;
+		public float maxPowerFactor;
 
 		// The multipler on packetSize that defines the maximum data bandwidth of the antenna.
 		[KSPField(isPersistant = false)]
-		public float maxDataFactor = 4f;
-
+		public float maxDataFactor;
+
+		/*
+		 * Properties
+		 * */
+		// Returns the current distance to the center of Kerbin, which is totally where the Kerbals keep their radioes.
+		protected double transmitDistance
+		{
+			get
+			{
+				Vector3d KerbinPos = this._Kerbin.position;
+				Vector3d ActivePos = base.vessel.GetWorldPos3D();
+
+				return (ActivePos - KerbinPos).magnitude;
+			}
+		}
+
+		// Returns the maximum distance this module can transmit
+		public double maxTransmitDistance
+		{
+			get
+			{
+				return Math.Sqrt (this.maxPowerFactor) * this.nominalRange;
+			}
+		}
+
+		/*
+		 * The next two functions overwrite the behavior of the stock functions and do not perform equivalently, except
+		 * in that they both return floats.  Here's some quick justification:
+		 * 
+		 * The stock implementation of GetTransmitterScore (which I cannot override) is:
+		 * 		Score = (1 + DataResourceCost) / DataRate
+		 * 
+		 * The stock DataRate and DataResourceCost are:
+		 * 		DataRate = packetSize / packetInterval
+		 * 		DataResourceCost = packetResourceCost / packetSize
+		 * 
+		 * So, the resulting score is essentially in terms of joules per byte per baud.  Rearranging that a bit, it
+		 * could also look like joule-seconds per byte per byte, or newton-meter-seconds per byte per byte.  Either way,
+		 * that metric is not a very reasonable one.
+		 * 
+		 * Two metrics that might make more sense are joules per byte or joules per byte per second.  The latter case
+		 * would look like:
+		 * 		DataRate = packetSize / packetInterval
+		 * 		DataResourceCost = packetResourceCost
+		 * 
+		 * The former case, which I've chosen to implement below, is:
+		 * 		DataRate = packetSize
+		 * 		DataResourceCost = packetResourceCost
+		 * 
+		 * So... hopefully that doesn't screw with anything else.
+		 * */
+		// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in
+		// terms of joules/byte
+		public new float DataRate
+		{
+			get
+			{
+				this.PreTransmit_SetPacketSize();
+				return this.packetSize;
+			}
+		}
+
+		// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas
+		// to be scored in terms of joules/byte
+		public new float DataResourceCost
+		{
+			get
+			{
+				this.PreTransmit_SetPacketResourceCost();
+
+				if (this.CanTransmit())
+				{
+					return this.packetResourceCost;
+				}
+				else
+				{
+					return float.PositiveInfinity;
+				}
+			}
+		}
+
+		public bool relayChecked
+		{
+			get;
+			protected set;
+		}
+
+		/*
+		 * Methods
+		 * */
 		// Build ALL the objects.
-		public ModuleLimitedDataTransmitter () : base() { }
+		public ModuleLimitedDataTransmitter () : base()
+		{
+			// Make the error posting prettier.
+			this.ErrorStyle = new UnityEngine.GUIStyle();
+			this.ErrorStyle.normal.textColor = (UnityEngine.Color)XKCDColors.OrangeRed;
+			this.ErrorStyle.active.textColor = (UnityEngine.Color)XKCDColors.OrangeRed;
+			this.ErrorStyle.hover.textColor = (UnityEngine.Color)XKCDColors.OrangeRed;
+			this.ErrorStyle.fontStyle = UnityEngine.FontStyle.Bold;
+			this.ErrorStyle.padding.top = 32;
+
+			this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT, this.ErrorStyle);
+		}
 
 		// At least once, when the module starts with a state on the launch pad or later, go find Kerbin.
 		public override void OnStart (StartState state)
 		{
+			this.relayChecked = false;
+
 			base.OnStart (state);
 
-			if (state >= StartState.PreLaunch && this._Kerbin == null)
-			{
-				// Go fetch Kerbin, because it is tricksy and hides from us.
-				List<CelestialBody> bodies = FlightGlobals.Bodies;
-
-				foreach (CelestialBody body in bodies)
-				{
-					if (body.name == "Kerbin")
-					{
-						this._Kerbin = body;
-						break;
-					}
-				}
-			}
+			if (state >= StartState.PreLaunch)
+			{
+				if (this._Kerbin == null)
+				{
+					// Go fetch Kerbin, because it is tricksy and hides from us.
+					this._Kerbin = FlightGlobals.Bodies.FirstOrDefault(b => b.name == "Kerbin");
+				}
+			}
+
+			// Pre-set the transmit cost and packet size when loading.
+			this.PreTransmit_SetPacketResourceCost();
+			this.PreTransmit_SetPacketSize();
 		}
 
 		// When the module loads, fetch the Squad KSPFields from the base.  This is necessary in part because
@@ -108,9 +203,28 @@
 		// work.
 		public override void OnLoad(ConfigNode node)
 		{
+			this.Fields.Load(node);
+			base.Fields.Load(node);
+
 			base.OnLoad (node);
+
 			this._basepacketSize = base.packetSize;
 			this._basepacketResourceCost = base.packetResourceCost;
+
+			Tools.PostDebugMessage(string.Format(
+				"{0} loaded:\n" +
+				"packetSize: {1}\n" +
+				"packetResourceCost: {2}\n" +
+				"nominalRange: {3}\n" +
+				"maxPowerFactor: {4}\n" +
+				"maxDataFactor: {5}\n",
+				this.name,
+				base.packetSize,
+				this._basepacketResourceCost,
+				this.nominalRange,
+				this.maxPowerFactor,
+				this.maxDataFactor
+			));
 		}
 
 		// Post an error in the communication messages describing the reason transmission has failed.  Currently there
@@ -118,13 +232,17 @@
 		protected void PostCannotTransmitError()
 		{
 			string ErrorText = string.Format (
-				"Unable to transmit: out of range!  Maximum range = {0}; Current range = {1}.",
-				this.maxTransmitDistance,
-				this.transmitDistance);
-			ScreenMessages.PostScreenMessage (new ScreenMessage (ErrorText, 4f, ScreenMessageStyle.UPPER_LEFT));
-		}
-
-		// Before transmission, set packetResourceCost.  Per above, packet size increases with the square of
+				"Unable to transmit: out of range!  Maximum range = {0}m; Current range = {1}m.",
+				Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2),
+				Tools.MuMech_ToSI((double)this.transmitDistance, 2)
+				);
+
+			this.ErrorMsg.message = ErrorText;
+
+			ScreenMessages.PostScreenMessage(this.ErrorMsg, true);
+		}
+
+		// Before transmission, set packetResourceCost.  Per above, packet cost increases with the square of
 		// distance.  packetResourceCost maxes out at _basepacketResourceCost * maxPowerFactor, at which point
 		// transmission fails (see CanTransmit).
 		protected void PreTransmit_SetPacketResourceCost()
@@ -160,27 +278,108 @@
 		public override string GetInfo()
 		{
 			string text = base.GetInfo();
-			text += "Nominal Range: " + this.nominalRange.ToString() + "\n";
-			text += "Maximum Range: " + this.maxTransmitDistance.ToString() + "\n";
+			text += "Nominal Range: " + Tools.MuMech_ToSI((double)this.nominalRange, 2) + "m\n";
+			text += "Maximum Range: " + Tools.MuMech_ToSI((double)this.maxTransmitDistance, 2) + "m\n";
 			return text;
 		}
 
 		// Override ModuleDataTransmitter.CanTransmit to return false when transmission is not possible.
 		public new bool CanTransmit()
 		{
-			if (this.transmitDistance > this.maxTransmitDistance)
-			{
-				return false;
-			}
-			return true;
+			if (this.transmitDistance < this.maxTransmitDistance)
+			{
+				return true;
+			}
+			else
+			{
+				this.relayChecked = true;
+
+				List<Vessel> nearbyVessels = FlightGlobals.Vessels
+					.Where(v => (v.GetWorldPos3D() - vessel.GetWorldPos3D()).magnitude < this.transmitDistance)
+					.ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Vessels in range: {1}",
+					this.GetType().Name,
+					nearbyVessels.Count
+					));
+
+				nearbyVessels = nearbyVessels.Where(v => v.id != vessel.id).ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Vessels in range excluding self: {1}",
+					this.GetType().Name,
+					nearbyVessels.Count
+					));
+
+				List<Part> nearbyParts = nearbyVessels.SelectMany(v => v.Parts).ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Parts in nearby vessels: {1}",
+					this.GetType().Name,
+					nearbyParts.Count
+					));
+
+				List<ModuleLimitedDataTransmitter> nearbyTransmitters = nearbyParts
+					.SelectMany(p => p.Modules.OfType<ModuleLimitedDataTransmitter>())
+					.ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Transmitters in nearby parts: {1}",
+					this.GetType().Name,
+					nearbyTransmitters.Count
+					));
+
+				nearbyTransmitters = nearbyTransmitters.Where(m => !m.relayChecked).ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Transmitters in nearby parts not already checked: {1}",
+					this.GetType().Name,
+					nearbyTransmitters.Count
+					));
+
+				nearbyTransmitters = nearbyTransmitters.Where(m => m.CanTransmit()).ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Transmitters in nearby parts not already checked that can transmit: {1}",
+					this.GetType().Name,
+					nearbyTransmitters.Count
+					));
+
+				List<ModuleLimitedDataTransmitter> nearbyRelays = this._relayVessels
+					.Where(v => (v.GetWorldPos3D() - vessel.GetWorldPos3D()).magnitude < this.transmitDistance)
+					.Where(v => v.id != vessel.id)
+					.SelectMany(v => v.Parts)
+					.SelectMany(p => p.Modules.OfType<ModuleLimitedDataTransmitter>())
+					.Where(m => !m.relayChecked)
+					.Where(m => m.CanTransmit())
+					.ToList();
+
+				Tools.PostDebugMessage(string.Format(
+					"{0}: Found {1} nearby relays.",
+					this.GetType().Name,
+					nearbyRelays.Count
+				));
+
+				this.relayChecked = false;
+
+				if (nearbyRelays.Count == 0)
+				{
+					return false;
+				}
+				else
+				{
+					return true;
+				}
+			}
 		}
 
 		// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit
 		// returns false.
 		public new void TransmitData(List<ScienceData> dataQueue)
 		{
-			PreTransmit_SetPacketSize ();
-			PreTransmit_SetPacketResourceCost ();
+			this.PreTransmit_SetPacketSize ();
+			this.PreTransmit_SetPacketResourceCost ();
 
 			Tools.PostDebugMessage (
 				"distance: " + this.transmitDistance
@@ -236,7 +435,10 @@
 				"maxTransmitDistance: {5}\n" +
 				"transmitDistance: {6}\n" +
 				"nominalRange: {7}\n" +
-				"CanTransmit: {8}",
+				"CanTransmit: {8}\n" +
+				"DataRate: {9}\n" +
+				"DataResourceCost: {10}\n" +
+				"TransmitterScore: {11}",
 				this.name,
 				this._basepacketSize,
 				base.packetSize,
@@ -245,7 +447,10 @@
 				this.maxTransmitDistance,
 				this.transmitDistance,
 				this.nominalRange,
-				this.CanTransmit()
+				this.CanTransmit(),
+				this.DataRate,
+				this.DataResourceCost,
+				ScienceUtil.GetTransmitterScore(this)
 				);
 			ScreenMessages.PostScreenMessage (new ScreenMessage (msg, 4f, ScreenMessageStyle.UPPER_RIGHT));
 		}
@@ -254,14 +459,108 @@
 
 	public static class Tools
 	{
-		// When debugging, be verbose.  The Conditional attribute prevents this from firing when not DEBUGging.
+		private static ScreenMessage debugmsg = new ScreenMessage("", 2f, ScreenMessageStyle.UPPER_RIGHT);
+
 		[System.Diagnostics.Conditional("DEBUG")]
-		public static void PostDebugMessage(string Str)
-		{
-			ScreenMessage Message = new ScreenMessage (Str, 4f, ScreenMessageStyle.LOWER_CENTER);
-			ScreenMessages.PostScreenMessage (Message);
+		public static void PostDebugMessage(string Msg)
+		{
+			if (HighLogic.LoadedScene > GameScenes.SPACECENTER)
+			{
+				debugmsg.message = Msg;
+				ScreenMessages.PostScreenMessage(debugmsg, true);
+			}
+
+			KSPLog.print(Msg);
+		}
+
+		/*
+		 * MuMech_ToSI is a part of the MuMechLib library, © 2013 r4m0n, used under the GNU GPL version 3.
+		 * */
+		public static string MuMech_ToSI(double d, int digits = 3, int MinMagnitude = 0, int MaxMagnitude = int.MaxValue)
+		{
+			float exponent = (float)Math.Log10(Math.Abs(d));
+			exponent = UnityEngine.Mathf.Clamp(exponent, (float)MinMagnitude, (float)MaxMagnitude);
+
+			if (exponent >= 0)
+			{
+				switch ((int)Math.Floor(exponent))
+				{
+					case 0:
+						case 1:
+						case 2:
+						return d.ToString("F" + digits);
+						case 3:
+						case 4:
+						case 5:
+						return (d / 1e3).ToString("F" + digits) + "k";
+						case 6:
+						case 7:
+						case 8:
+						return (d / 1e6).ToString("F" + digits) + "M";
+						case 9:
+						case 10:
+						case 11:
+						return (d / 1e9).ToString("F" + digits) + "G";
+						case 12:
+						case 13:
+						case 14:
+						return (d / 1e12).ToString("F" + digits) + "T";
+						case 15:
+						case 16:
+						case 17:
+						return (d / 1e15).ToString("F" + digits) + "P";
+						case 18:
+						case 19:
+						case 20:
+						return (d / 1e18).ToString("F" + digits) + "E";
+						case 21:
+						case 22:
+						case 23:
+						return (d / 1e21).ToString("F" + digits) + "Z";
+						default:
+						return (d / 1e24).ToString("F" + digits) + "Y";
+				}
+			}
+			else if (exponent < 0)
+			{
+				switch ((int)Math.Floor(exponent))
+				{
+					case -1:
+						case -2:
+						case -3:
+						return (d * 1e3).ToString("F" + digits) + "m";
+						case -4:
+						case -5:
+						case -6:
+						return (d * 1e6).ToString("F" + digits) + "μ";
+						case -7:
+						case -8:
+						case -9:
+						return (d * 1e9).ToString("F" + digits) + "n";
+						case -10:
+						case -11:
+						case -12:
+						return (d * 1e12).ToString("F" + digits) + "p";
+						case -13:
+						case -14:
+						case -15:
+						return (d * 1e15).ToString("F" + digits) + "f";
+						case -16:
+						case -17:
+						case -18:
+						return (d * 1e18).ToString("F" + digits) + "a";
+						case -19:
+						case -20:
+						case -21:
+						return (d * 1e21).ToString("F" + digits) + "z";
+						default:
+						return (d * 1e24).ToString("F" + digits) + "y";
+				}
+			}
+			else
+			{
+				return "0";
+			}
 		}
 	}
 }
-
-