Fix pvp exceptions

Author: EmandM

com.unity.netcode.gameobjects/Tests/Editor/DocumentationCodeSamples/Serialization/SerializationCustomization.cs

@@ -1,27 +1,48 @@
 using NUnit.Framework;
 using Unity.Collections;
+using Unity.Netcode;
 
-namespace Unity.Netcode.EditorTests.Documentation.Serialization
+namespace DocumentationCodeSamples
 {
     #region HealthStruct
+    /// <summary>Container for storing health data for a player or item.</summary>
     public struct Health
     {
+        /// <summary>
+        /// The maximum health that this player or item can have.
+        /// This is unlikely to change often.
+        /// </summary>
         public uint MaxHealth;
+
+        /// <summary>
+        /// The current level of health that this player or item has.
+        /// This is likely to change regularly.
+        /// </summary>
         public int CurrentHealth;
     }
     #endregion
 
     #region FastBuffer
-    // Tells the Netcode how to serialize and deserialize our custom type.
+    /// <summary>Tells the Netcode how to serialize and deserialize our custom type.</summary>
     // The class name doesn't matter here.
     public static class FastBufferExtensions
     {
+        /// <summary>
+        /// Extension method to override the serialization for a custom type.
+        /// </summary>
+        /// <param name="writer">Buffer to write values into.</param>
+        /// <param name="health">The type to customize or override.</param>
         public static void WriteValueSafe(this FastBufferWriter writer, in Health health)
         {
             writer.WriteValueSafe(health.MaxHealth);
             writer.WriteValueSafe(health.CurrentHealth);
         }
 
+        /// <summary>
+        /// Extension method to override the de-serialization for a custom type.
+        /// </summary>
+        /// <param name="reader">Buffer to read values from.</param>
+        /// <param name="health">The type to customize or override.</param>
         public static void ReadValueSafe(this FastBufferReader reader, out Health health)
         {
             reader.ReadValueSafe(out uint max);
@@ -32,9 +53,16 @@ public static void ReadValueSafe(this FastBufferReader reader, out Health health
     #endregion
 
     #region BufferSerializer
+    /// <summary>Tells the <see cref="BufferSerializer{TReaderWriter}"/> how to serialize and deserialize our custom type.</summary>
     // The class name doesn't matter here.
     public static class BufferSerializerExtensions
     {
+        /// <summary>
+        /// Extension method to override bi-directional serialization for a custom type.
+        /// </summary>
+        /// <param name="serializer">Bi-directional serial</param>
+        /// <param name="health">The type to customize or override.</param>
+        /// <typeparam name="TReaderWriter">Boilerplate syntax to enable the bi-directional serialization.</typeparam>
         public static void SerializeValue<TReaderWriter>(this BufferSerializer<TReaderWriter> serializer, ref Health health) where TReaderWriter : IReaderWriter
         {
             // Because the BufferSerializer already knows how to read and write the primitive types

com.unity.netcode.gameobjects/Tests/Runtime/DocumentationCodeSamples/NetworkVariable/CustomNetworkVariable.cs

@@ -40,11 +40,15 @@ public override void OnNetworkSpawn()
         }
     }
 
-    // Bare minimum example of NetworkVariableBase derived class
+    /// <summary>
+    /// Bare minimum example of NetworkVariableBase derived class
+    /// </summary>
     [Serializable]
     public class MyCustomNetworkVariable : NetworkVariableBase
     {
-        // Managed list of class instances
+        /// <summary>
+        /// Managed list of class instances
+        /// </summary>
         public List<SomeData> SomeDataToSynchronize = new List<SomeData>();
 
         /// <summary>
@@ -96,25 +100,37 @@ public override void ReadField(FastBufferReader reader)
             }
         }
 
+        /// <summary>
+        /// Used to write partial updates rather than synchronizing the full state on every change.
+        /// </summary>
+        /// <param name="writer">The stream to write the state to</param>
+        public override void WriteDelta(FastBufferWriter writer)
+        {
+            // Not implemented for this example, instead we can write the field
+            WriteField(writer);
+        }
+
+        /// <summary>
+        /// Used to read partial updates rather than synchronizing the full state on every change.
+        /// </summary>
+        /// <inheritdoc/>
         public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
         {
             // Not implemented for this example, instead we can read the field
             ReadField(reader);
         }
 
-        public override void WriteDelta(FastBufferWriter writer)
-        {
-            // Not implemented for this example, instead we can write the field
-            WriteField(writer);
-        }
     }
 
-    // Bare minimum example of generic NetworkVariableBase derived class
+    /// <summary>
+    /// Bare minimum example of generic NetworkVariableBase derived class
+    /// </summary>
+    /// <typeparam name="T">Generic type marker</typeparam>
     [Serializable]
     [GenerateSerializationForGenericParameter(0)]
     public class MyCustomGenericNetworkVariable<T> : NetworkVariableBase
     {
-        // Managed list of class instances
+        /// <summary>Managed list of class instances</summary>
         public List<T> SomeDataToSynchronize = new List<T>();
 
         /// <summary>
@@ -152,21 +168,30 @@ public override void ReadField(FastBufferReader reader)
             }
         }
 
-        public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
-        {
-            // Not implemented for this example, instead we can read the field
-            ReadField(reader);
-        }
-
+        /// <summary>
+        /// Used to write partial updates rather than synchronizing the full state on every change.
+        /// </summary>
+        /// <param name="writer">The stream to write the state to</param>
         public override void WriteDelta(FastBufferWriter writer)
         {
             // Not implemented for this example, instead we can write the field
             WriteField(writer);
         }
+
+        /// <summary>
+        /// Used to read partial updates rather than synchronizing the full state on every change.
+        /// </summary>
+        /// <inheritdoc/>
+        public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
+        {
+            // Not implemented for this example, instead we can read the field
+            ReadField(reader);
+        }
     }
 
-    // Example managed class used as the item type in the
-    // MyCustomNetworkVariable.SomeDataToSynchronize list
+    /// <summary>
+    /// Example managed class used as the item type in <see cref="MyCustomNetworkVariable.SomeDataToSynchronize"/>
+    /// </summary>
     [Serializable]
     public class SomeData
     {