NetworkPrefab and NetworkPrefabs corrections

Author: michalChrobot

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkPrefab.cs

@@ -57,6 +57,11 @@ public class NetworkPrefab
         /// </summary>
         public GameObject OverridingTargetPrefab;
 
+        /// <summary>
+        /// Compares this NetworkPrefab with another to determine equality
+        /// </summary>
+        /// <param name="other">The NetworkPrefab to compare against</param>
+        /// <returns>True if all fields match between the two NetworkPrefabs, false otherwise</returns>
         public bool Equals(NetworkPrefab other)
         {
             return Override == other.Override &&
@@ -66,6 +71,12 @@ public bool Equals(NetworkPrefab other)
                    OverridingTargetPrefab == other.OverridingTargetPrefab;
         }
 
+        /// <summary>
+        /// Gets the GlobalObjectIdHash of the source prefab based on the current override settings
+        /// </summary>
+        /// <returns>The hash value identifying the source prefab</returns>
+        /// <exception cref="InvalidOperationException">Thrown when required prefab references are missing or invalid</exception>
+        /// <exception cref="ArgumentOutOfRangeException">Thrown when Override has an invalid value</exception>
         public uint SourcePrefabGlobalObjectIdHash
         {
             get
@@ -98,6 +109,12 @@ public uint SourcePrefabGlobalObjectIdHash
             }
         }
 
+        /// <summary>
+        /// Gets the GlobalObjectIdHash of the target prefab when using prefab overrides
+        /// </summary>
+        /// <returns>The hash value identifying the target prefab, or 0 if no override is set</returns>
+        /// <exception cref="InvalidOperationException">Thrown when required prefab references are missing or invalid</exception>
+        /// <exception cref="ArgumentOutOfRangeException">Thrown when Override has an invalid value</exception>
         public uint TargetPrefabGlobalObjectIdHash
         {
             get
@@ -122,6 +139,11 @@ public uint TargetPrefabGlobalObjectIdHash
             }
         }
 
+        /// <summary>
+        /// Validates the NetworkPrefab configuration to ensure all required fields are properly set
+        /// </summary>
+        /// <param name="index">Optional index used for error reporting when validating lists of prefabs</param>
+        /// <returns>True if the NetworkPrefab is valid and ready for use, false otherwise</returns>
         public bool Validate(int index = -1)
         {
             NetworkObject networkObject;
@@ -224,6 +246,10 @@ public bool Validate(int index = -1)
             return true;
         }
 
+        /// <summary>
+        /// Returns a string representation of this NetworkPrefab's source and target hash values
+        /// </summary>
+        /// <returns>A string containing the source and target hash values</returns>
         public override string ToString()
         {
             return $"{{SourceHash: {SourceHashToOverride}, TargetHash: {TargetPrefabGlobalObjectIdHash}}}";

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkPrefabs.cs

@@ -39,6 +39,9 @@ public class NetworkPrefabs
         [NonSerialized]
         public Dictionary<uint, uint> OverrideToNetworkPrefab = new Dictionary<uint, uint>();
 
+        /// <summary>
+        /// Gets the read-only list of all registered network prefabs
+        /// </summary>
         public IReadOnlyList<NetworkPrefab> Prefabs => m_Prefabs;
 
         [NonSerialized]
@@ -84,6 +87,7 @@ internal void Shutdown()
         /// Processes the <see cref="NetworkPrefabsList"/> if one is present for use during runtime execution,
         /// else processes <see cref="Prefabs"/>.
         /// </summary>
+        /// /// <param name="warnInvalid">When true, logs warnings about invalid prefabs that are removed during initialization</param>
         public void Initialize(bool warnInvalid = true)
         {
             m_Prefabs.Clear();
@@ -156,6 +160,8 @@ public void Initialize(bool warnInvalid = true)
         /// <summary>
         /// Add a new NetworkPrefab instance to the list
         /// </summary>
+        /// <param name="networkPrefab">The NetworkPrefab to add</param>
+        /// <returns>True if the prefab was successfully added, false if it was invalid or already registered</returns>
         /// <remarks>
         /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
         ///
@@ -177,6 +183,7 @@ public bool Add(NetworkPrefab networkPrefab)
         /// <summary>
         /// Remove a NetworkPrefab instance from the list
         /// </summary>
+        /// <param name="prefab">The NetworkPrefab to remove</param>
         /// <remarks>
         /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
         ///
@@ -199,6 +206,7 @@ public void Remove(NetworkPrefab prefab)
         /// <summary>
         /// Remove a NetworkPrefab instance with matching <see cref="NetworkPrefab.Prefab"/> from the list
         /// </summary>
+        /// <param name="prefab">The GameObject to match against for removal</param>
         /// <remarks>
         /// The framework does not synchronize this list between clients. Any runtime changes must be handled manually.
         ///

pvpExceptions.json

@@ -21,19 +21,7 @@
           "Unity.Netcode.NetworkConfig: Prefabs: undocumented",
           "Unity.Netcode.NetworkConfig: NetworkTopology: undocumented",
           "Unity.Netcode.NetworkConfig: UseCMBService: undocumented",
-          "Unity.Netcode.NetworkConfig: AutoSpawnPlayerPrefabClientSide: undocumented",
-          "Unity.Netcode.NetworkPrefab: bool Equals(NetworkPrefab): undocumented",
-          "Unity.Netcode.NetworkPrefab: SourcePrefabGlobalObjectIdHash: undocumented",
-          "Unity.Netcode.NetworkPrefab: TargetPrefabGlobalObjectIdHash: undocumented",
-          "Unity.Netcode.NetworkPrefab: bool Validate(int): undocumented",
-          "Unity.Netcode.NetworkPrefab: string ToString(): undocumented",
-          "Unity.Netcode.NetworkPrefabs: Prefabs: undocumented",
-          "Unity.Netcode.NetworkPrefabs: void Finalize(): undocumented",
-          "Unity.Netcode.NetworkPrefabs: void Initialize(bool): missing <param name=\"warnInvalid\">",
-          "Unity.Netcode.NetworkPrefabs: bool Add(NetworkPrefab): missing <param name=\"networkPrefab\">",
-          "Unity.Netcode.NetworkPrefabs: bool Add(NetworkPrefab): missing <returns>",
-          "Unity.Netcode.NetworkPrefabs: void Remove(NetworkPrefab): missing <param name=\"prefab\">",
-          "Unity.Netcode.NetworkPrefabs: void Remove(GameObject): missing <param name=\"prefab\">",
+          "Unity.Netcode.NetworkConfig: AutoSpawnPlayerPrefabClientSide: undocumented",          
           "Unity.Netcode.ConnectionEventData: EventType: undocumented",
           "Unity.Netcode.RpcException: undocumented",
           "Unity.Netcode.RpcException: .ctor(string): undocumented",
@@ -45,7 +33,6 @@
           "Unity.Netcode.CustomMessagingManager.HandleNamedMessageDelegate: missing <param name=\"messagePayload\">",
           "Unity.Netcode.GenerateSerializationForGenericParameterAttribute: .ctor(int): undocumented",
           "Unity.Netcode.GenerateSerializationForTypeAttribute: .ctor(Type): undocumented",
-          
           "Unity.Netcode.NetworkList<T>: void Finalize(): undocumented",
           "Unity.Netcode.NetworkVariable<T>: CheckExceedsDirtinessThreshold: undocumented",
           "Unity.Netcode.NetworkVariable<T>: bool ExceedsDirtinessThreshold(): undocumented",