1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 | // AntennaRange // // ModuleLimitedDataTransmitter.cs // // Copyright © 2014-2015, 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 System.Collections.Generic; using System.Text; using ToadicusTools; using UnityEngine; namespace AntennaRange { /// <summary> /// <para>ModuleLimitedDataTransmitter is designed as a drop-in replacement for ModuleDataTransmitter, and handles /// rangefinding, power scaling, and data scaling for antennas during science transmission. Its functionality /// varies with three tunables: nominalRange, maxPowerFactor, and maxDataFactor, set in .cfg files.</para> /// /// <para>In general, the scaling functions assume the following relation:</para> /// /// <para> D² α P/R,</para> /// /// <para>where D is the total transmission distance, P is the transmission power, and R is the data rate.</para> /// </summary> public class ModuleLimitedDataTransmitter : ModuleDataTransmitter, IScienceDataTransmitter, IAntennaRelay { // Stores the packetResourceCost as defined in the .cfg file. private float _basepacketResourceCost; // Stores the packetSize as defined in the .cfg file. private float _basepacketSize; // Every antenna is a relay. private AntennaRelay relay; // Sometimes we will need to communicate errors; this is how we do it. private ScreenMessage ErrorMsg; /// <summary> /// When additive ranges are enabled, the distance from Kerbin at which the antenna will perform exactly as /// prescribed by packetResourceCost and packetSize. /// </summary> [KSPField(isPersistant = false)] public double nominalRange; /// <summary> /// When additive ranges are disabled, the distance from Kerbin at which the antenna will perform exactly as /// prescribed by packetResourceCost and packetSize. /// </summary> [KSPField(isPersistant = false)] public double simpleRange; /// <summary> /// Relay status string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Status")] public string UIrelayStatus; /// <summary> /// Relay target string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Relay")] public string UIrelayTarget; /// <summary> /// Transmit distance string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Transmission Distance")] public string UItransmitDistance; /// <summary> /// The nominal range string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Nominal Range")] public string UInominalLinkDistance; /// <summary> /// Maximum distance string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Maximum Range")] public string UImaxTransmitDistance; /// <summary> /// Packet size string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Size")] public string UIpacketSize; /// <summary> /// Packet cost string for use in action menus. /// </summary> [KSPField(isPersistant = false, guiActive = true, guiName = "Packet Cost")] public string UIpacketCost; /// <summary> /// The multiplier on packetResourceCost that defines the maximum power output of the antenna. When the power /// cost exceeds packetResourceCost * maxPowerFactor, transmission will fail. /// </summary> [KSPField(isPersistant = false)] public float maxPowerFactor; /// <summary> /// The multipler on packetSize that defines the maximum data bandwidth of the antenna. /// </summary> [KSPField(isPersistant = false)] public float maxDataFactor; /// <summary> /// The packet throttle. /// </summary> [KSPField( isPersistant = true, guiName = "Packet Throttle", guiUnits = "%", guiActive = true, guiActiveEditor = false )] [UI_FloatRange(maxValue = 100f, minValue = 2.5f, stepIncrement = 2.5f)] public float packetThrottle; private bool actionUIUpdate; /* * Properties * */ /// <summary> /// Gets the parent Vessel. /// </summary> public new Vessel vessel { get { if (base.vessel != null) { return base.vessel; } else if (this.part != null && this.part.vessel != null) { return this.part.vessel; } else if ( this.part.protoPartSnapshot != null && this.part.protoPartSnapshot.pVesselRef != null && this.part.protoPartSnapshot.pVesselRef.vesselRef != null ) { return this.part.protoPartSnapshot.pVesselRef.vesselRef; } else { this.LogError("Vessel and/or part reference are null, returning null vessel."); this.LogError(new System.Diagnostics.StackTrace().ToString()); return null; } } } /// <summary> /// Gets the target <see cref="AntennaRange.IAntennaRelay"/>relay. /// </summary> public IAntennaRelay targetRelay { get { if (this.relay == null) { return null; } return this.relay.targetRelay; } } /// <summary> /// Gets a value indicating whether this <see cref="AntennaRange.IAntennaRelay"/> Relay is communicating /// directly with Kerbin. /// </summary> public bool KerbinDirect { get { if (this.relay != null) { return this.relay.KerbinDirect; } return false; } } /// <summary> /// Gets or sets the nominal link distance, in meters. /// </summary> public double NominalLinkSqrDistance { get { if (this.relay != null) { return this.relay.NominalLinkSqrDistance; } return 0d; } } /// <summary> /// Gets or sets the maximum link distance, in meters. /// </summary> public double MaximumLinkSqrDistance { get { if (this.relay != null) { return this.relay.MaximumLinkSqrDistance; } return 0d; } } /// <summary> /// Gets the distance to the nearest relay or Kerbin, whichever is closer. /// </summary> public double CurrentLinkSqrDistance { get { if (this.relay == null) { return double.PositiveInfinity; } return this.relay.CurrentLinkSqrDistance; } } /// <summary> /// Gets the link status. /// </summary> public ConnectionStatus LinkStatus { get { if (this.relay == null) { return ConnectionStatus.None; } return this.relay.LinkStatus; } } /// <summary> /// Gets the nominal transmit distance at which the Antenna behaves just as prescribed by Squad's config. /// </summary> public double nominalTransmitDistance { get { if (ARConfiguration.UseAdditiveRanges) { return this.nominalRange; } else { return this.simpleRange; } } } /// <summary> /// The maximum distance at which this relay can operate. /// </summary> public double maxTransmitDistance { get; protected set; } /// <summary> /// The first CelestialBody blocking line of sight to a /// </summary> public CelestialBody firstOccludingBody { get { return this.relay.firstOccludingBody; } } /* * 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. * */ /// <summary> /// Override ModuleDataTransmitter.DataRate to just return packetSize, because we want antennas to be scored in /// terms of joules/byte /// </summary> public new float DataRate { get { this.PreTransmit_SetPacketSize(); if (this.CanTransmit()) { return this.packetSize; } else { return float.Epsilon; } } } /// <summary> /// Override ModuleDataTransmitter.DataResourceCost to just return packetResourceCost, because we want antennas /// to be scored in terms of joules/byte /// </summary> public new double DataResourceCost { get { this.PreTransmit_SetPacketResourceCost(); if (this.CanTransmit()) { return this.packetResourceCost; } else { return float.PositiveInfinity; } } } /// <summary> /// Gets the Part title. /// </summary> public string Title { get { if (this.part != null && this.part.partInfo != null) { return this.part.partInfo.title; } return string.Empty; } } /* * Methods * */ // Build ALL the objects. public ModuleLimitedDataTransmitter () : base() { this.ErrorMsg = new ScreenMessage("", 4f, false, ScreenMessageStyle.UPPER_LEFT); this.packetThrottle = 100f; } /// <summary> /// PartModule OnAwake override; runs at Unity Awake. /// </summary> public override void OnAwake() { base.OnAwake(); this._basepacketSize = base.packetSize; this._basepacketResourceCost = base.packetResourceCost; Tools.PostDebugMessage(string.Format( "{0} loaded:\n" + "packetSize: {1}\n" + "packetResourceCost: {2}\n" + "nominalTransmitDistance: {3}\n" + "maxPowerFactor: {4}\n" + "maxDataFactor: {5}\n", this.name, base.packetSize, this._basepacketResourceCost, this.nominalTransmitDistance, this.maxPowerFactor, this.maxDataFactor )); } /// <summary> /// PartModule OnStart override; runs at Unity Start. /// </summary> /// <param name="state">State.</param> public override void OnStart (StartState state) { base.OnStart (state); if (state >= StartState.PreLaunch) { this.maxTransmitDistance = Math.Sqrt(this.maxPowerFactor) * this.nominalTransmitDistance; this.relay = new AntennaRelay(this); this.relay.nominalTransmitDistance = this.nominalTransmitDistance; this.relay.maxTransmitDistance = this.maxTransmitDistance; this.UImaxTransmitDistance = string.Format(Tools.SIFormatter, "{0:S3}m", this.maxTransmitDistance); GameEvents.onPartActionUICreate.Add(this.onPartActionUICreate); GameEvents.onPartActionUIDismiss.Add(this.onPartActionUIDismiss); } } /// <summary> /// When the module loads, fetch the Squad KSPFields from the base. This is necessary in part because /// overloading packetSize and packetResourceCostinto a property in ModuleLimitedDataTransmitter didn't /// work. /// </summary> /// <param name="node"><see cref="ConfigNode"/> with data for this module.</param> public override void OnLoad(ConfigNode node) { this.Fields.Load(node); base.Fields.Load(node); base.OnLoad (node); this.maxTransmitDistance = Math.Sqrt(this.maxPowerFactor) * this.nominalTransmitDistance; } /// <summary> /// Override ModuleDataTransmitter.GetInfo to add nominal and maximum range to the VAB description. /// </summary> public override string GetInfo() { StringBuilder sb = Tools.GetStringBuilder(); string text; sb.Append(base.GetInfo()); sb.AppendFormat(Tools.SIFormatter, "Nominal Range: {0:S3}m\n", this.nominalTransmitDistance); sb.AppendFormat(Tools.SIFormatter, "Maximum Range: {0:S3}m\n", this.maxTransmitDistance); text = sb.ToString(); Tools.PutStringBuilder(sb); return text; } /// <summary> /// Determines whether this instance can transmit. /// <c>true</c> if this instance can transmit; otherwise, <c>false</c>. /// </summary> public new bool CanTransmit() { if (this.part == null || this.relay == null) { return false; } switch (this.part.State) { case PartStates.DEAD: case PartStates.DEACTIVATED: Tools.PostDebugMessage(string.Format( "{0}: {1} on {2} cannot transmit: {3}", this.GetType().Name, this.part.partInfo.title, this.vessel.vesselName, Enum.GetName(typeof(PartStates), this.part.State) )); return false; default: break; } return this.relay.CanTransmit(); } /// <summary> /// Finds the nearest relay. /// </summary> public void FindNearestRelay() { if (this.relay != null) { this.relay.FindNearestRelay(); } } /// <summary> /// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit /// returns false. /// </summary> /// <param name="dataQueue">List of <see cref="ScienceData"/> to transmit.</param> /// <param name="callback">Callback function</param> public new void TransmitData(List<ScienceData> dataQueue, Callback callback) { this.LogDebug( "TransmitData(List<ScienceData> dataQueue, Callback callback) called. dataQueue.Count={0}", dataQueue.Count ); this.FindNearestRelay(); this.PreTransmit_SetPacketSize(); this.PreTransmit_SetPacketResourceCost(); if (this.CanTransmit()) { ScreenMessages.PostScreenMessage(this.buildTransmitMessage(), 4f, ScreenMessageStyle.UPPER_LEFT); this.LogDebug( "CanTransmit in TransmitData, calling base.TransmitData with dataQueue=[{0}] and callback={1}", dataQueue.SPrint(), callback == null ? "null" : callback.ToString() ); if (callback == null) { base.TransmitData(dataQueue); } else { base.TransmitData(dataQueue, callback); } } else { Tools.PostDebugMessage(this, "{0} unable to transmit during TransmitData.", this.part.partInfo.title); var logger = Tools.DebugLogger.New(this); IList<ModuleScienceContainer> vesselContainers = this.vessel.getModulesOfType<ModuleScienceContainer>(); ModuleScienceContainer scienceContainer; for (int cIdx = 0; cIdx < vesselContainers.Count; cIdx++) { scienceContainer = vesselContainers[cIdx]; logger.AppendFormat("Checking ModuleScienceContainer in {0}\n", scienceContainer.part.partInfo.title); if ( scienceContainer.capacity != 0 && scienceContainer.GetScienceCount() >= scienceContainer.capacity ) { logger.Append("\tInsufficient capacity, skipping.\n"); continue; } List<ScienceData> dataStored = new List<ScienceData>(); ScienceData data; for (int dIdx = 0; dIdx < dataQueue.Count; dIdx++) { data = dataQueue[dIdx]; if (!scienceContainer.allowRepeatedSubjects && scienceContainer.HasData(data)) { logger.Append("\tAlready contains subject and repeated subjects not allowed, skipping.\n"); continue; } logger.AppendFormat("\tAcceptable, adding data on subject {0}... ", data.subjectID); if (scienceContainer.AddData(data)) { logger.Append("done, removing from queue.\n"); dataStored.Add(data); } #if DEBUG else { logger.Append("failed.\n"); } #endif } dataQueue.RemoveAll(i => dataStored.Contains(i)); logger.AppendFormat("\t{0} data left in queue.", dataQueue.Count); } logger.Print(); if (dataQueue.Count > 0) { StringBuilder sb = Tools.GetStringBuilder(); sb.Append('['); sb.Append(this.part.partInfo.title); sb.AppendFormat("]: {0} data items could not be saved: no space available in data containers.\n"); sb.Append("Data to be discarded:\n"); ScienceData data; for (int dIdx = 0; dIdx < dataQueue.Count; dIdx++) { data = dataQueue[dIdx]; sb.AppendFormat("\t{0}\n", data.title); } ScreenMessages.PostScreenMessage(sb.ToString(), 4f, ScreenMessageStyle.UPPER_LEFT); Tools.PostDebugMessage(sb.ToString()); Tools.PutStringBuilder(sb); } this.PostCannotTransmitError(); } Tools.PostDebugMessage ( "distance: " + this.CurrentLinkSqrDistance + " packetSize: " + this.packetSize + " packetResourceCost: " + this.packetResourceCost ); } /// <summary> /// Override ModuleDataTransmitter.TransmitData to check against CanTransmit and fail out when CanTransmit /// returns false. /// </summary> /// <param name="dataQueue">List of <see cref="ScienceData"/> to transmit.</param> public new void TransmitData(List<ScienceData> dataQueue) { this.LogDebug( "TransmitData(List<ScienceData> dataQueue) called, dataQueue.Count={0}", dataQueue.Count ); this.TransmitData(dataQueue, null); } /// <summary> /// Override ModuleDataTransmitter.StartTransmission to check against CanTransmit and fail out when CanTransmit /// returns false. /// </summary> public new void StartTransmission() { this.FindNearestRelay(); PreTransmit_SetPacketSize (); PreTransmit_SetPacketResourceCost (); Tools.PostDebugMessage ( "distance: " + this.CurrentLinkSqrDistance + " packetSize: " + this.packetSize + " packetResourceCost: " + this.packetResourceCost ); if (this.CanTransmit()) { ScreenMessages.PostScreenMessage(this.buildTransmitMessage(), 4f, ScreenMessageStyle.UPPER_LEFT); base.StartTransmission(); } else { this.PostCannotTransmitError (); } } /// <summary> /// MonoBehaviour Update /// </summary> public void Update() { if (this.actionUIUpdate) { this.UImaxTransmitDistance = string.Format(Tools.SIFormatter, "{0:S3}m", Math.Sqrt(this.MaximumLinkSqrDistance)); this.UInominalLinkDistance = string.Format(Tools.SIFormatter, "{0:S3}m", Math.Sqrt(this.NominalLinkSqrDistance)); if (this.CanTransmit()) { this.UIrelayStatus = this.LinkStatus.ToString(); this.UItransmitDistance = string.Format(Tools.SIFormatter, "{0:S3}m", Math.Sqrt(this.CurrentLinkSqrDistance)); this.UIpacketSize = string.Format(Tools.SIFormatter, "{0:S3}MiT", this.DataRate); this.UIpacketCost = string.Format(Tools.SIFormatter, "{0:S3}EC", this.DataResourceCost); } else { if (this.relay.firstOccludingBody == null) { this.UItransmitDistance = string.Format(Tools.SIFormatter, "{0:S3}m", Math.Sqrt(this.CurrentLinkSqrDistance)); this.UIrelayStatus = "Out of range"; } else { this.UItransmitDistance = "N/A"; this.UIrelayStatus = string.Format("Blocked by {0}", this.relay.firstOccludingBody.bodyName); } this.UIpacketSize = "N/A"; this.UIpacketCost = "N/A"; } if (this.KerbinDirect) { this.UIrelayTarget = AntennaRelay.Kerbin.bodyName; } else { this.UIrelayTarget = this.targetRelay.ToString(); } } } /// <summary> /// Returns a <see cref="System.String"/> that represents the current <see cref="AntennaRange.ModuleLimitedDataTransmitter"/>. /// </summary> /// <returns>A <see cref="System.String"/> that represents the current <see cref="AntennaRange.ModuleLimitedDataTransmitter"/>.</returns> public override string ToString() { StringBuilder sb = Tools.GetStringBuilder(); string msg; sb.Append(this.part.partInfo.title); if (vessel != null) { sb.Append(" on "); sb.Append(vessel.vesselName); } else if ( this.part != null && this.part.protoPartSnapshot != null && this.part.protoPartSnapshot != null && this.part.protoPartSnapshot.pVesselRef != null ) { sb.Append(" on "); sb.Append(this.part.protoPartSnapshot.pVesselRef.vesselName); } msg = sb.ToString(); Tools.PutStringBuilder(sb); return msg; } // When we catch an onPartActionUICreate event for our part, go ahead and update every frame to look pretty. private void onPartActionUICreate(Part eventPart) { if (eventPart == base.part) { this.actionUIUpdate = true; } } // When we catch an onPartActionUIDismiss event for our part, stop updating every frame to look pretty. private void onPartActionUIDismiss(Part eventPart) { if (eventPart == base.part) { this.actionUIUpdate = false; } } // Post an error in the communication messages describing the reason transmission has failed. Currently there // is only one reason for this. private void PostCannotTransmitError() { string ErrorText = string.Intern("Unable to transmit: no visible receivers in range!"); this.ErrorMsg.message = string.Format( "<color='#{0}{1}{2}{3}'><b>{4}</b></color>", ((int)(XKCDColors.OrangeRed.r * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.g * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.b * 255f)).ToString("x2"), ((int)(XKCDColors.OrangeRed.a * 255f)).ToString("x2"), ErrorText ); Tools.PostDebugMessage(this.GetType().Name + ": " + this.ErrorMsg.message); ScreenMessages.PostScreenMessage(this.ErrorMsg, false); } // 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). private void PreTransmit_SetPacketResourceCost() { if (ARConfiguration.FixedPowerCost || this.CurrentLinkSqrDistance <= this.NominalLinkSqrDistance) { base.packetResourceCost = this._basepacketResourceCost; } else { float rangeFactor = (float)(this.CurrentLinkSqrDistance / this.NominalLinkSqrDistance); base.packetResourceCost = this._basepacketResourceCost * rangeFactor; } 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. private void PreTransmit_SetPacketSize() { if (!ARConfiguration.FixedPowerCost && this.CurrentLinkSqrDistance >= this.NominalLinkSqrDistance) { base.packetSize = this._basepacketSize; } else { float rangeFactor = (float)(this.NominalLinkSqrDistance / this.CurrentLinkSqrDistance); base.packetSize = Mathf.Min( this._basepacketSize * rangeFactor, this._basepacketSize * this.maxDataFactor ); } base.packetSize *= this.packetThrottle / 100f; } private string buildTransmitMessage() { StringBuilder sb = Tools.GetStringBuilder(); string msg; sb.Append("["); sb.Append(base.part.partInfo.title); sb.Append("]: "); sb.Append("Beginning transmission "); if (this.KerbinDirect) { sb.Append("directly to Kerbin."); } else { sb.Append("via "); sb.Append(this.relay.targetRelay); } msg = sb.ToString(); Tools.PutStringBuilder(sb); return msg; } #if DEBUG // When debugging, it's nice to have a button that just tells you everything. [KSPEvent (guiName = "Show Debug Info", active = true, guiActive = true)] public void DebugInfo() { PreTransmit_SetPacketSize (); PreTransmit_SetPacketResourceCost (); DebugPartModule.DumpClassObject(this); } [KSPEvent (guiName = "Dump Vessels", active = true, guiActive = true)] public void PrintAllVessels() { StringBuilder sb = Tools.GetStringBuilder(); sb.Append("Dumping FlightGlobals.Vessels:"); Vessel vessel; for (int i = 0; i < FlightGlobals.Vessels.Count; i++) { vessel = FlightGlobals.Vessels[i]; sb.AppendFormat("\n'{0} ({1})'", vessel.vesselName, vessel.id); } Tools.PostDebugMessage(sb.ToString()); Tools.PutStringBuilder(sb); } [KSPEvent (guiName = "Dump RelayDB", active = true, guiActive = true)] public void DumpRelayDB() { RelayDatabase.Instance.Dump(); } #endif } } |