From 5e48743a92a7a666458ec599fc480cc0c9547aeb Mon Sep 17 00:00:00 2001
From: drewcassidy <drewcassidy@me.com>
Date: Fri, 16 Aug 2019 21:26:01 -0700
Subject: [PATCH] Documentation pass

---
 .../GameData/ReStock/Plugins/Restock.dll      | Bin 28160 -> 28160 bytes
 Source/Restock/ModuleRestockHeatEffects.cs    |  16 ++++++++++++++--
 Source/Restock/ModuleRestockISRUAnimation.cs  |   3 +++
 3 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/Distribution/Restock/GameData/ReStock/Plugins/Restock.dll b/Distribution/Restock/GameData/ReStock/Plugins/Restock.dll
index 3b94b8b0f08be980238b94c4778871afa26f8b6b..0675b12906c4e268cd68d42c72af4ff6452800c3 100644
GIT binary patch
delta 1322
zcmZ`(ZA=_h6utM&?kwyw`@OJWr?AlOE))t>3tMS0Dd0*?1=5m+(hZFiu#slhS=)r-
zwh&Mul3H@x#MqG3)Py!tl65r1A66TQNuxIPM=K^&tzx5zX+w-@sQ&N{U-geW*)w;}
zIq$st-n`7fJPyp`nGw_2Y4zs#*ao~hetAFk5@N_aJOr?h0-}`KFod%-h^O!Zq41bz
z>j03_-PL-t_}#Qs8x@d9NdP91JOE%#nI4zs$ECbdQjaBE*lyVD2BA$FgB{D-L4)-f
zWjID@%TDaj?^~jXU+GnuPQ(~Rt&NQ1)-A#z(N(L80h+fq<&;a1aGAoJcz9R^kRu-e
zfYwgCY!Mu#e%liMO2@K7xI`0K&tVJQ%c{rov_&zPy-Fp{(Cf-!e~}py@iETuC@#et
zuHvdx5n4H+y^3dz*z56SO4-xOn`{gZ8*)s$Of`;9`{I8Xk4#ez4cjT-8N^9?)>(pg
z=oRM=xJb>ea(qYwt_b5NuE;5u1ro_=4my$I-c2RkwWmUYS_H5GxFjvahWK$dSmiRC
zR%zJNhFw0{!MBwjY})ubFZF-Oy!L>J6){)Rl#JDku+ExIwj@KmMI~&dgxmCdF3aoQ
z>UHl&?9GxhlABk(Mr_@hb;n!WsibwSxs_~>Nz(f1Gj|w?esfpgb;|V=U>!Z}Da?5&
zudkBROv1FeEGwv8q@?E_>U6-n5qDFccdO-3D<m|tji$Z%9-ochsCng$p60oQwqO6r
zJA(cNLomf>nG3&fz=~R-4`d%gp7w4|L{Su8l5q~QOZX53{WUnMzvy2??4W&lgV?0s
z&g&6;wrbTH+;EZ2E;;<OvA{{LwJQwqUyMhc&TYI?Xc$C)6L+5d?*G`%=HJH|eW+j%
zbN^8Qidy%=NDY9Kcd01a+E~x`cXYL|#e^!wgHgtrU@_y}U~#1?0&q)I$^rONY-cPr
z8;r;9U$4tE7BB$cc@3UbstFb6ssiB|DJo=Ga_p87I^`%ccCSjQkjlyDL)$GXtKFF@
z<%fOrN660X-ywCGy=666?m%x0Z^|sf1v^4L7}&U6yO!}9nlpzmAa3|nL1!v&E8KvX
z@)d|QmS?Dx+}6gC-)z%4X7I_Fgbw}3svaSI3ORb?jxm3p+5ru46plcWuOo0Ax}Xl?
z&<k<>+m<$)^Kf8Syw!4|Vf50CbEi+vKGJu_9KvO>2-Q81&M;fiJ@B!R?fStEr|f(C
z(qA)xdzuCB<x&36@yBV72D@_14Z{EpG|^S$)SKO%SHAA7o9O=Hg@W&|y+Jp-4wbEv
z$=E8%LDhS%C+1$Qol3oT?6sM*JbdjpO|kAL@Pgjg-G{pUrALzZ{3+el`vAu)EdK(R
CJ53e<

delta 1279
zcmZ`(ZERCz6n@WpdvCY4x3{<Lwsx-jWbNGt+d5=+Rv_R)nFQIw7TjdGh}$sKtlkF0
zoRv<tgk{UL9A|=tKZYL|kYrw!kP!CA;2$(0IL+etQZqFY=0c1?V&b{`VEpkW_w>2X
z^SsYF_q}hLo`dupym#Dkb4T|(nehVnIP=L~XhDFGc<>lwZCJvqu>(SI28ZA%3?p!l
zc;;Eg0I&5vWwh|$Ej4d<GG<E&j9GZ{MH5=qptuI5Wr%%Nt#qGhbDD%c%2^_%ENNXP
zn`1(4KTcVnfllL|H3smh(U9!|*pD$=Gu4c(iZ61!Yzu&ZbGF@is=yMeMO#P9wE$yM
z<Sb)M--O%j5jcc{_6P7a9(IJ_M?B@&0UL1M(F7^1l1*lh9EOuPBERAjMV9Cvrwos*
z%3iI3P_@i;6~Wm+T_esW*o7(Ql>90gwP924(#J5W9B^KLjQLB%bBYd|u*emJQQYpT
zglT-;brY^*i&_h_m{ucHFRGEF_a&A{o~NKUQ#8A!lBV|532ZYkW@k(l^lU4Q^adGh
z(t5k@p{L}OX_uC^e0c`Do_xd$gP)PCUn62!^b7jJYKCTzW|yqV5N%N<Sux?Z?0opR
z*Ppf0Py3v_4k;^HzT!1w%Sl~|Z5*RX1wFRvmUBH8LGQw8w+4stH+LPJMZc#Q%JFGW
zY2NJGTT+^ZTgulvg8B$1J@YV$o!&yI#sP1Qb;iaL`mZ)T?=ABDO;{C|zvu+@=6a)X
z+j|^*SM27e?*EE7?X+2zRkxAO?FMRlCodu|IA~7u9OPEgAqe`SaL9Psw+PUQZTUkG
zHonjA<8-z*2cl3gB2%EG{bau2C}I6wD*Zp3kCQlAc%#%b@WI_QdG3e*V|%~o9-K6e
z6%T>`w#-;r`yLjLGUlRPDvPx@H_`7~MxeCS0t)sAV^l8$E2!QHR)iH^!e)3_Dq&an
zMyl1K$#|T;N4PfY7bsyrcuk&EjD{-w3J11Dh;fNMP@a>39gt$gIK2v{LIFztD74Y4
zklLHAV3C%CcSBBMABF-;?2OH1X#%5JTbC{JZ*vrm@o+Jo2!AJ28-6aQm`_1%mV(Lp
z4qEt4y+P)o4P64bjav<UT$pD0Mswr1&$!>(Zg(?w<B3137Qd|7{=xHmx82%0v1q)|
zrErx?POFs%-07(-(FX4H7sip7TvATl-!aW#R|}_&d5!K%^iOjMPxa)96~l~G;KiOY
z*X6_?V+9xHcV;HyTh*)oM)7V>cl`=E*1AHPLGh~#`#NVw+Xf14;t^WDdYv$Fai$~}
chK<SI0l+$5U^ox{Bk<Et8ftt2GIiGf01fs)H2?qr

diff --git a/Source/Restock/ModuleRestockHeatEffects.cs b/Source/Restock/ModuleRestockHeatEffects.cs
index 951a9671..883a43cd 100644
--- a/Source/Restock/ModuleRestockHeatEffects.cs
+++ b/Source/Restock/ModuleRestockHeatEffects.cs
@@ -6,28 +6,40 @@ namespace Restock
 {
     public class ModuleRestockHeatEffects : PartModule
     {
+        // enable the heat glow emissive
         [KSPField] public bool enableHeatEmissive = false;
 
-        [KSPField] public string shaderProperty = string.Empty;
+        // what shader property to modify. must be a color.
+        [KSPField] public string shaderProperty = "_EmissiveColor";
 
+        // animation curve for the red channel
         [KSPField] public FloatCurve redCurve= new FloatCurve();
 
+        // animation curve for the green channel
         [KSPField] public FloatCurve greenCurve = new FloatCurve();
-
+        
+        // animation curve for the blue channel
         [KSPField] public FloatCurve blueCurve = new FloatCurve();
 
+        // animation curve for the alpha channel
         [KSPField] public FloatCurve alphaCurve = new FloatCurve();
 
+        // draper point, the temperature in Kelvin where materials start glowing
         [KSPField] public double draperPoint = 798.0;
         
+        // temperature where the animation is at its maximum
         [KSPField] public double lerpMax = double.NaN;
         
+        // temperature where the animation is at its minimum, added with draperPoint
         [KSPField] public double lerpMin = 0.0;
 
+        // use the part's core temperature? (overrides useSkinTemp)
         [KSPField] public bool useCoreTemp = false;
         
+        // use the part's skin temperature?
         [KSPField] public bool useSkinTemp = false;
 
+        // should the module disable the stock blackbody glow effect on the included renderers?
         [KSPField] public bool disableBlackbody = false;
         
         [KSPField] public List<Renderer> renderers = new List<Renderer>();
diff --git a/Source/Restock/ModuleRestockISRUAnimation.cs b/Source/Restock/ModuleRestockISRUAnimation.cs
index 520235dc..17159358 100644
--- a/Source/Restock/ModuleRestockISRUAnimation.cs
+++ b/Source/Restock/ModuleRestockISRUAnimation.cs
@@ -6,10 +6,13 @@ namespace Restock
 {
     public class ModuleRestockISRUAnimation : PartModule
     {
+        // name of the deploy animation to use
         [KSPField] public string deployAnimationName = "";
 
+        // speed to run the animation when deploying
         [KSPField] public float deploySpeed = 1.0f;
 
+        // speed to run the animation when retracting
         [KSPField] public float retractSpeed = 1.0f;
 
         public bool isDeployed = false;