v1.7.7.0 (Winter Update 2024)

Barotrauma/BarotraumaClient/ClientSource/Items/Components/ItemComponent.cs

@@ -62,6 +62,10 @@ namespace Barotrauma.Items.Components
         private readonly Dictionary<ActionType, List<ItemSound>> sounds;
         private Dictionary<ActionType, SoundSelectionMode> soundSelectionModes;
 
+        /// <summary>
+        /// Starts the timer for  delayed client-side corrections (<see cref="StartDelayedCorrection(IReadMessage, float, bool)"/>) - in other words,
+        /// the client will not attempt to read server updates for this component until the timer elapses.
+        /// </summary>
         protected float correctionTimer;
 
         public float IsActiveTimer;
@@ -760,7 +764,11 @@ namespace Barotrauma.Items.Components
         /// </summary>
         protected virtual void CreateGUI() { }
 
-        //Starts a coroutine that will read the correct state of the component from the NetBuffer when correctionTimer reaches zero.
+        /// <summary>
+        /// Starts a coroutine that will read the correct state of the component from the NetBuffer when correctionTimer reaches zero.
+        /// Useful in cases where we a client is constantly adjusting some value, and we don't want state updates from the server to interfere with it 
+        /// (e.g. setting the value back to what a client just set it to, when the client has already modified the value further).
+        /// </summary>
         protected void StartDelayedCorrection(IReadMessage buffer, float sendingTime, bool waitForMidRoundSync = false)
         {
             if (delayedCorrectionCoroutine != null) { CoroutineManager.StopCoroutines(delayedCorrectionCoroutine); }