ModuleLimitedDataTransmitter: Added option to fix power cost and degrade data performance at long range.
--- a/ARConfiguration.cs
+++ b/ARConfiguration.cs
@@ -8,6 +8,8 @@
using ToadicusTools;
using UnityEngine;
+[assembly: KSPAssemblyDependency("ToadicusTools", 0, 0)]
+
namespace AntennaRange
{
[KSPAddon(KSPAddon.Startup.SpaceCentre, false)]
@@ -17,6 +19,22 @@
private Rect configWindowPos;
private IButton toolbarButton;
+
+ private System.Version runningVersion;
+
+ private KSP.IO.PluginConfiguration _config;
+ private KSP.IO.PluginConfiguration config
+ {
+ get
+ {
+ if (this._config == null)
+ {
+ this._config = KSP.IO.PluginConfiguration.CreateForType<AntennaRelay>();
+ }
+
+ return this._config;
+ }
+ }
public void Awake()
{
@@ -30,8 +48,11 @@
public void OnGUI()
{
+ // Only runs once, if the Toolbar is available.
if (this.toolbarButton == null && ToolbarManager.ToolbarAvailable)
{
+ this.runningVersion = this.GetType().Assembly.GetName().Version;
+
Tools.PostDebugMessage(this, "Toolbar available; initializing button.");
this.toolbarButton = ToolbarManager.Instance.add("AntennaRange", "ARConfiguration");
@@ -44,14 +65,12 @@
this.showConfigWindow = !this.showConfigWindow;
};
- var config = KSP.IO.PluginConfiguration.CreateForType<AntennaRelay>();
+ this.configWindowPos = this.LoadConfigValue("configWindowPos", this.configWindowPos);
+ AntennaRelay.requireLineOfSight = this.LoadConfigValue("requireLineOfSight", false);
+ ARFlightController.requireConnectionForControl =
+ this.LoadConfigValue("requireConnectionForControl", false);
- config.load();
-
- this.configWindowPos = config.GetValue<Rect>("configWindowPos", this.configWindowPos);
- AntennaRelay.requireLineOfSight = config.GetValue<bool>("requireLineOfSight", false);
-
- config.save();
+ Debug.Log(string.Format("{0} v{1} - ARonfiguration loaded!", this.GetType().Name, this.runningVersion));
}
if (this.showConfigWindow)
@@ -59,7 +78,7 @@
Rect configPos = GUILayout.Window(354163056,
this.configWindowPos,
this.ConfigWindow,
- "AntennaRange Configuration",
+ string.Format("AntennaRange {0}.{1}", this.runningVersion.Major, this.runningVersion.Minor),
GUILayout.ExpandHeight(true),
GUILayout.ExpandWidth(true)
);
@@ -79,11 +98,27 @@
GUILayout.BeginVertical(GUILayout.ExpandHeight(true));
GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
+
bool requireLineOfSight = GUILayout.Toggle(AntennaRelay.requireLineOfSight, "Require Line of Sight");
if (requireLineOfSight != AntennaRelay.requireLineOfSight)
{
AntennaRelay.requireLineOfSight = requireLineOfSight;
this.SaveConfigValue("requireLineOfSight", requireLineOfSight);
+ }
+
+ GUILayout.EndHorizontal();
+
+ GUILayout.BeginHorizontal(GUILayout.ExpandWidth(true));
+
+ bool requireConnectionForControl =
+ GUILayout.Toggle(
+ ARFlightController.requireConnectionForControl,
+ "Require Connection for Probe Control"
+ );
+ if (requireConnectionForControl != ARFlightController.requireConnectionForControl)
+ {
+ ARFlightController.requireConnectionForControl = requireConnectionForControl;
+ this.SaveConfigValue("requireConnectionForControl", requireConnectionForControl);
}
GUILayout.EndHorizontal();
@@ -103,22 +138,18 @@
private T LoadConfigValue<T>(string key, T defaultValue)
{
- var config = KSP.IO.PluginConfiguration.CreateForType<AntennaRelay>();
-
- config.load();
+ this.config.load();
return config.GetValue(key, defaultValue);
}
private void SaveConfigValue<T>(string key, T value)
{
- var config = KSP.IO.PluginConfiguration.CreateForType<AntennaRelay>();
+ this.config.load();
- config.load();
+ this.config.SetValue(key, value);
- config.SetValue(key, value);
-
- config.save();
+ this.config.save();
}
}
}
--- /dev/null
+++ b/ARFlightController.cs
@@ -1,1 +1,147 @@
+// AntennaRange
+//
+// ARFlightController.cs
+//
+// Copyright © 2014, toadicus
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without modification,
+// are permitted provided that the following conditions are met:
+//
+// 1. Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+//
+// 2. Redistributions in binary form must reproduce the above copyright notice,
+// this list of conditions and the following disclaimer in the documentation and/or other
+// materials provided with the distribution.
+//
+// 3. Neither the name of the copyright holder nor the names of its contributors may be used
+// to endorse or promote products derived from this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+using KSP;
+using System;
+using ToadicusTools;
+using UnityEngine;
+
+namespace AntennaRange
+{
+ [KSPAddon(KSPAddon.Startup.Flight, false)]
+ public class ARFlightController : MonoBehaviour
+ {
+ #region Static Members
+ public static bool requireConnectionForControl;
+ #endregion
+
+ #region Properties
+ public ControlTypes currentControlLock
+ {
+ get
+ {
+ if (this.lockID == string.Empty)
+ {
+ return ControlTypes.None;
+ }
+
+ return InputLockManager.GetControlLock(this.lockID);
+ }
+ }
+
+ public string lockID
+ {
+ get;
+ protected set;
+ }
+
+ public ControlTypes lockSet
+ {
+ get
+ {
+ return ControlTypes.ALL_SHIP_CONTROLS;
+ }
+ }
+
+ public Vessel vessel
+ {
+ get
+ {
+ if (FlightGlobals.ready && FlightGlobals.ActiveVessel != null)
+ {
+ return FlightGlobals.ActiveVessel;
+ }
+
+ return null;
+ }
+ }
+ #endregion
+
+ #region MonoBehaviour LifeCycle
+ protected void Awake()
+ {
+ this.lockID = "ARConnectionRequired";
+
+ GameEvents.onGameSceneLoadRequested.Add(this.onSceneChangeRequested);
+ GameEvents.onVesselChange.Add(this.onVesselChange);
+ }
+
+ protected void FixedUpdate()
+ {
+ // If we are requiring a connection for control, the vessel does not have any adequately staffed pods,
+ // and the vessel does not have any connected relays...
+ if (
+ HighLogic.LoadedSceneIsFlight &&
+ requireConnectionForControl &&
+ this.vessel != null &&
+ this.vessel.vesselType != VesselType.EVA &&
+ !this.vessel.hasCrewCommand() &&
+ !this.vessel.HasConnectedRelay())
+ {
+ // ...and if the controls are not currently locked...
+ if (currentControlLock == ControlTypes.None)
+ {
+ // ...lock the controls.
+ InputLockManager.SetControlLock(this.lockSet, this.lockID);
+ }
+ }
+ // ...otherwise, if the controls are locked...
+ else if (currentControlLock != ControlTypes.None)
+ {
+ // ...unlock the controls.
+ InputLockManager.RemoveControlLock(this.lockID);
+ }
+ }
+
+ protected void Destroy()
+ {
+ InputLockManager.RemoveControlLock(this.lockID);
+
+ GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChangeRequested);
+ GameEvents.onVesselChange.Remove(this.onVesselChange);
+ }
+ #endregion
+
+ #region Event Handlers
+ protected void onSceneChangeRequested(GameScenes scene)
+ {
+ if (scene != GameScenes.FLIGHT)
+ {
+ InputLockManager.RemoveControlLock(this.lockID);
+ }
+ }
+
+ protected void onVesselChange(Vessel vessel)
+ {
+ InputLockManager.RemoveControlLock(this.lockID);
+ }
+ #endregion
+ }
+}
+
+
--- a/AntennaRange.cfg
+++ b/AntennaRange.cfg
@@ -37,7 +37,7 @@
// maxDataFactor: The multipler on packetSize that defines the maximum data bandwidth of the antenna.
//
-@PART[longAntenna]
+@PART[longAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech2]
{
@MODULE[ModuleDataTransmitter]
{
@@ -48,7 +48,7 @@
}
}
-@PART[mediumDishAntenna]
+@PART[mediumDishAntenna]:FOR[AntennaRange]:NEEDS[!RemoteTech2]
{
@MODULE[ModuleDataTransmitter]
{
@@ -59,7 +59,7 @@
}
}
-@PART[commDish]
+@PART[commDish]:FOR[AntennaRange]:NEEDS[!RemoteTech2]
{
@MODULE[ModuleDataTransmitter]
{
--- a/AntennaRange.csproj
+++ b/AntennaRange.csproj
@@ -9,7 +9,7 @@
<OutputType>Library</OutputType>
<RootNamespace>AntennaRange</RootNamespace>
<AssemblyName>AntennaRange</AssemblyName>
- <ReleaseVersion>0.6.2</ReleaseVersion>
+ <ReleaseVersion>1.1</ReleaseVersion>
<SynchReleaseVersion>false</SynchReleaseVersion>
<TargetFrameworkVersion>v3.5</TargetFrameworkVersion>
<UseMSBuildEngine>False</UseMSBuildEngine>
@@ -77,41 +77,15 @@
<Compile Include="AntennaRelay.cs" />
<Compile Include="ProtoAntennaRelay.cs" />
<Compile Include="RelayDatabase.cs" />
- <Compile Include="..\ToadicusTools\VesselExtensions.cs">
- <Link>ToadicusTools\VesselExtensions.cs</Link>
- </Compile>
- <Compile Include="..\ToadicusTools\Tools.cs">
- <Link>ToadicusTools\Tools.cs</Link>
- </Compile>
- <Compile Include="..\ToadicusTools\MuMech_Tools.cs">
- <Link>ToadicusTools\MuMech_Tools.cs</Link>
- </Compile>
<Compile Include="RelayExtensions.cs" />
- <Compile Include="..\ToadicusTools\ModuleDBWrapper.cs">
- <Link>ToadicusTools\ModuleDBWrapper.cs</Link>
- </Compile>
- <Compile Include="..\ToadicusTools\PrefabDBWrapper.cs">
- <Link>ToadicusTools\PrefabDBWrapper.cs</Link>
- </Compile>
- <Compile Include="..\ToadicusTools\IModuleDB.cs">
- <Link>ToadicusTools\IModuleDB.cs</Link>
- </Compile>
<Compile Include="ARConfiguration.cs" />
- <Compile Include="..\ToadicusTools\Wrapper\ToolbarWrapper.cs">
- <Link>ToadicusTools\ToolbarWrapper.cs</Link>
- </Compile>
- <Compile Include="..\ToadicusTools\WindowTools.cs">
- <Link>WindowTools.cs</Link>
- </Compile>
+ <Compile Include="ARFlightController.cs" />
</ItemGroup>
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
<ItemGroup>
<None Include="AntennaRange.cfg">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
- </ItemGroup>
- <ItemGroup>
- <Folder Include="ToadicusTools\" />
</ItemGroup>
<ItemGroup>
<Reference Include="Assembly-CSharp">
@@ -127,4 +101,10 @@
<Private>False</Private>
</Reference>
</ItemGroup>
+ <ItemGroup>
+ <ProjectReference Include="..\ToadicusTools\ToadicusTools.csproj">
+ <Project>{D48A5542-6655-4149-BC27-B27DF0466F1C}</Project>
+ <Name>ToadicusTools</Name>
+ </ProjectReference>
+ </ItemGroup>
</Project>
--- a/AntennaRelay.cs
+++ b/AntennaRelay.cs
@@ -40,6 +40,8 @@
// We don't have a Bard, so we'll hide Kerbin here.
protected CelestialBody Kerbin;
+ protected CelestialBody _firstOccludingBody;
+
protected IAntennaRelay _nearestRelayCache;
protected IAntennaRelay moduleRef;
@@ -82,6 +84,18 @@
}
/// <summary>
+ /// Gets the first occluding body.
+ /// </summary>
+ /// <value>The first occluding body.</value>
+ public CelestialBody firstOccludingBody
+ {
+ get
+ {
+ return this._firstOccludingBody;
+ }
+ }
+
+ /// <summary>
/// Gets the transmit distance.
/// </summary>
/// <value>The transmit distance.</value>
@@ -134,7 +148,11 @@
{
if (
this.transmitDistance > this.maxTransmitDistance ||
- (requireLineOfSight && this.nearestRelay == null && !this.vessel.hasLineOfSightTo(this.Kerbin))
+ (
+ requireLineOfSight &&
+ this.nearestRelay == null &&
+ !this.vessel.hasLineOfSightTo(this.Kerbin, out this._firstOccludingBody)
+ )
)
{
return false;
@@ -170,6 +188,8 @@
this,
this.vessel.id
));
+
+ this._firstOccludingBody = null;
// Set this vessel as checked, so that we don't check it again.
RelayDatabase.Instance.CheckedVesselsTable[vessel.id] = true;
@@ -211,7 +231,7 @@
}
// Skip vessels to which we do not have line of sight.
- if (requireLineOfSight && !this.vessel.hasLineOfSightTo(potentialVessel))
+ if (requireLineOfSight && !this.vessel.hasLineOfSightTo(potentialVessel, out this._firstOccludingBody))
{
Tools.PostDebugMessage(
this,
--- a/ModuleLimitedDataTransmitter.cs
+++ b/ModuleLimitedDataTransmitter.cs
@@ -54,6 +54,10 @@
* */
public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay
{
+ // If true, use a fixed power cost at the configured value and degrade data rates instead of increasing power
+ // requirements.
+ public static bool fixedPowerCost;
+
// Stores the packetResourceCost as defined in the .cfg file.
protected float _basepacketResourceCost;
@@ -74,6 +78,9 @@
[KSPField(isPersistant = false)]
public float nominalRange;
+ [KSPField(isPersistant = false, guiActive = true, guiName = "Relay")]
+ public string UIrelayStatus;
+
[KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")]
public string UItransmitDistance;
@@ -94,6 +101,16 @@
// The multipler on packetSize that defines the maximum data bandwidth of the antenna.
[KSPField(isPersistant = false)]
public float maxDataFactor;
+
+ [KSPField(
+ isPersistant = true,
+ guiName = "Packet Throttle",
+ guiUnits = "%",
+ guiActive = true,
+ guiActiveEditor = false
+ )]
+ [UI_FloatRange(maxValue = 100f, minValue = 2.5f, stepIncrement = 2.5f)]
+ public float packetThrottle;
protected bool actionUIUpdate;
@@ -207,6 +224,7 @@
public ModuleLimitedDataTransmitter () : base()
{
this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT);
+ this.packetThrottle = 100f;
}
// At least once, when the module starts with a state on the launch pad or later, go find Kerbin.
@@ -280,7 +298,7 @@
// transmission fails (see CanTransmit).
protected void PreTransmit_SetPacketResourceCost()
{
- if (this.transmitDistance <= this.nominalRange)
+ if (fixedPowerCost || this.transmitDistance <= this.nominalRange)
{
base.packetResourceCost = this._basepacketResourceCost;
}
@@ -289,13 +307,15 @@
base.packetResourceCost = this._basepacketResourceCost
* (float)Math.Pow (this.transmitDistance / this.nominalRange, 2);
}
+
+ base.packetResourceCost *= this.packetThrottle / 100f;
}
// Before transmission, set packetSize. Per above, packet size increases with the inverse square of
// distance. packetSize maxes out at _basepacketSize * maxDataFactor.
protected void PreTransmit_SetPacketSize()
{
- if (this.transmitDistance >= this.nominalRange)
+ if (!fixedPowerCost && this.transmitDistance >= this.nominalRange)
{
base.packetSize = this._basepacketSize;
}
@@ -305,6 +325,8 @@
this._basepacketSize * (float)Math.Pow (this.nominalRange / this.transmitDistance, 2),
this._basepacketSize * this.maxDataFactor);
}
+
+ base.packetSize *= this.packetThrottle / 100f;
}
// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description.
@@ -424,9 +446,27 @@
{
if (this.actionUIUpdate)
{
- this.UItransmitDistance = Tools.MuMech_ToSI(this.transmitDistance) + "m";
- this.UIpacketSize = this.CanTransmit() ? Tools.MuMech_ToSI(this.DataRate) + "MiT" : "N/A";
- this.UIpacketCost = this.CanTransmit() ? Tools.MuMech_ToSI(this.DataResourceCost) + "E" : "N/A";
+ if (this.CanTransmit())
+ {
+ this.UIrelayStatus = string.Intern("Connected");
+ this.UItransmitDistance = Tools.MuMech_ToSI(this.transmitDistance) + "m";
+ this.UIpacketSize = Tools.MuMech_ToSI(this.DataRate) + "MiT";
+ this.UIpacketCost = Tools.MuMech_ToSI(this.DataResourceCost) + "E";
+ }
+ else
+ {
+ if (this.relay.firstOccludingBody == null)
+ {
+ this.UIrelayStatus = string.Intern("Out of range");
+ }
+ else
+ {
+ this.UIrelayStatus = string.Format("Blocked by {0}", this.relay.firstOccludingBody.bodyName);
+ }
+ this.UImaxTransmitDistance = "N/A";
+ this.UIpacketSize = "N/A";
+ this.UIpacketCost = "N/A";
+ }
}
}
--- a/Properties/AssemblyInfo.cs
+++ b/Properties/AssemblyInfo.cs
@@ -37,7 +37,7 @@
// The assembly version has the format "{Major}.{Minor}.{Build}.{Revision}".
// The form "{Major}.{Minor}.*" will automatically update the build and revision,
// and "{Major}.{Minor}.{Build}.*" will update just the revision.
-[assembly: AssemblyVersion("1.0.0.*")]
+[assembly: AssemblyVersion("1.2.*")]
// The following attributes are used to specify the signing key for the assembly,
// if desired. See the Mono documentation for more information about signing.
//[assembly: AssemblyDelaySign(false)]
--- a/RelayExtensions.cs
+++ b/RelayExtensions.cs
@@ -76,6 +76,24 @@
{
return RelayDatabase.Instance[vessel].Values.ToList();
}
+
+ /// <summary>
+ /// Determines if the specified vessel has a connected relay.
+ /// </summary>
+ /// <returns><c>true</c> if the specified vessel has a connected relay; otherwise, <c>false</c>.</returns>
+ /// <param name="vessel"></param>
+ public static bool HasConnectedRelay(this Vessel vessel)
+ {
+ foreach (IAntennaRelay relay in RelayDatabase.Instance[vessel].Values)
+ {
+ if (relay.CanTransmit())
+ {
+ return true;
+ }
+ }
+
+ return false;
+ }
}
}