NetworkObject corrections

Author: michalChrobot

com.unity.netcode.gameobjects/Runtime/Core/NetworkObject.cs

@@ -512,22 +512,27 @@ public enum OwnershipStatus
             ///  When set, this instance will have no permissions (i.e. cannot distribute, transfer, etc).
             /// </summary>
             None = 0,
+
             /// <summary>
             ///  When set, this instance will be automatically redistributed when a client joins (if not locked or no request is pending) or leaves.
             /// </summary>
             Distributable = 1 << 0,
+
             /// <summary>
             /// When set, a non-owner can obtain ownership immediately (without requesting and as long as it is not locked).
             /// </summary>
             Transferable = 1 << 1,
+
             /// <summary>
             /// When set, a non-owner must request ownership from the owner (will always get locked once ownership is transferred).
             /// </summary>
             RequestRequired = 1 << 2,
+
             /// <summary>
             /// When set, only the current session owner may have ownership over this object.
             /// </summary>
             SessionOwner = 1 << 3,
+
             /// <summary>
             /// Used within the inspector view only. When selected it will set the Distributable, Transferable, and RequestRequired flags or if those flags are already set it will select the SessionOwner flag by itself.
             /// </summary>
@@ -627,10 +632,29 @@ public bool SetOwnershipLock(bool lockOwnership = true)
         /// </summary>
         public enum OwnershipPermissionsFailureStatus
         {
+            /// <summary>
+            /// The NetworkObject is locked and ownership cannot be acquired
+            /// </summary>
             Locked,
+
+            /// <summary>
+            /// The NetworkObject requires an ownership request via RequestOwnership
+            /// </summary>
             RequestRequired,
+
+            /// <summary>
+            /// The NetworkObject is already processing an ownership request and ownership cannot be acquired at this time
+            /// </summary>
             RequestInProgress,
+
+            /// <summary>
+            /// The NetworkObject does not have the OwnershipStatus.Transferable flag set and ownership cannot be acquired
+            /// </summary>
             NotTransferrable,
+
+            /// <summary>
+            /// The NetworkObject has the OwnershipStatus.SessionOwner flag set and ownership cannot be acquired
+            /// </summary>
             SessionOwnerOnly
         }
 
@@ -658,11 +682,35 @@ public enum OwnershipPermissionsFailureStatus
         /// </summary>
         public enum OwnershipRequestStatus
         {
+            /// <summary>
+            /// The request for ownership was sent (does not mean it will be granted, but the request was sent)
+            /// </summary>
             RequestSent,
+
+            /// <summary>
+            /// The current client is already the owner (no need to request ownership)
+            /// </summary>
             AlreadyOwner,
+
+            /// <summary>
+            /// The OwnershipStatus.RequestRequired flag is not set on this NetworkObject
+            /// </summary>
             RequestRequiredNotSet,
+
+            /// <summary>
+            /// The current owner has locked ownership which means requests are not available at this time
+            /// </summary
             Locked,
+
+            /// <summary>
+            /// There is already a known request in progress. You can scan for ownership changes and try again
+            /// after a specific period of time or no longer attempt to request ownership
+            /// </summary>
             RequestInProgress,
+
+            /// <summary>
+            /// This object is marked as SessionOwnerOnly and therefore cannot be requested
+            /// </summary>
             SessionOwnerOnly,
         }
 
@@ -820,19 +868,31 @@ internal void OwnershipRequest(ulong clientRequestingOwnership)
         /// <summary>
         /// What is returned via <see cref="OnOwnershipRequestResponse"/> after an ownership request has been sent via <see cref="RequestOwnership"/>
         /// </summary>
-        /// <remarks>
-        /// Approved: Granted ownership, and returned after the requesting client has gained ownership on the local instance.
-        /// Locked: Was locked after request was sent.
-        /// RequestInProgress: A request started before this request was received.
-        /// CannotRequest: The RequestRequired status changed while the request was in flight.
-        /// Denied: General denied message that is only set if <see cref="OnOwnershipRequested"/> returns false by the authority instance.
-        /// </remarks>
         public enum OwnershipRequestResponseStatus
         {
+            /// <summary>
+            /// The ownership request was approved and the requesting client has gained ownership on the local instance
+            /// </summary>
             Approved,
+
+            /// <summary>
+            /// The ownership request was denied because the object became locked after the request was sent
+            /// </summary>
             Locked,
+
+            /// <summary>
+            /// The ownership request was denied because another request was already in progress when this request was received
+            /// </summary>
             RequestInProgress,
+
+            /// <summary>
+            /// The ownership request was denied because the RequestRequired status changed while the request was in flight
+            /// </summary>
             CannotRequest,
+
+            /// <summary>
+            /// The ownership request was denied by the authority instance (<see cref="OnOwnershipRequested"/> returned false)
+            /// </summary>
             Denied,
         }
 
@@ -867,8 +927,19 @@ internal void OwnershipRequestResponse(OwnershipRequestResponseStatus ownershipR
         /// </summary>
         public enum OwnershipLockActions
         {
+            /// <summary>
+            /// No additional locking action will be performed
+            /// </summary>
             None,
+
+            /// <summary>
+            /// Sets the specified ownership flags and then locks the NetworkObject
+            /// </summary>
             SetAndLock,
+
+            /// <summary>
+            /// Sets the specified ownership flags and then unlocks the NetworkObject
+            /// </summary>
             SetAndUnlock
         }
 
@@ -1165,6 +1236,7 @@ public void SetSceneObjectStatus(bool isSceneObject = false)
         /// Delegate type for checking visibility
         /// </summary>
         /// <param name="clientId">The clientId to check visibility for</param>
+        /// <returns>True if the object should be visible to the specified client, false otherwise</returns>
         public delegate bool VisibilityDelegate(ulong clientId);
 
         /// <summary>
@@ -1176,6 +1248,7 @@ public void SetSceneObjectStatus(bool isSceneObject = false)
         /// Delegate type for checking spawn options
         /// </summary>
         /// <param name="clientId">The clientId to check spawn options for</param>
+        /// <returns>True if the object should be spawned for the specified client, false otherwise</returns>
         public delegate bool SpawnDelegate(ulong clientId);
 
         /// <summary>
@@ -2649,6 +2722,14 @@ internal bool SetNetworkVariableData(FastBufferReader reader, ulong clientId)
             return true;
         }
 
+        /// <summary>
+        /// Gets the order index of a NetworkBehaviour instance within the ChildNetworkBehaviours collection
+        /// </summary>
+        /// <param name="instance">The NetworkBehaviour instance to find the index for</param>
+        /// <returns>
+        /// The index of the NetworkBehaviour in the ChildNetworkBehaviours collection.
+        /// Returns 0 if the instance is not found.
+        /// </returns>
         public ushort GetNetworkBehaviourOrderIndex(NetworkBehaviour instance)
         {
             // read the cached index, and verify it first

pvpExceptions.json

@@ -41,33 +41,6 @@
           "Unity.Netcode.NetworkManager: void NetworkUpdate(NetworkUpdateStage): undocumented",
           "Unity.Netcode.NetworkManager.ReanticipateDelegate: undocumented",
           "Unity.Netcode.NetworkObject: void SetSceneObjectStatus(bool): undocumented",
-          "Unity.Netcode.NetworkObject: ushort GetNetworkBehaviourOrderIndex(NetworkBehaviour): undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipStatus: None: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipStatus: Distributable: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipStatus: Transferable: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipStatus: RequestRequired: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipStatus: SessionOwner: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipPermissionsFailureStatus: Locked: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipPermissionsFailureStatus: RequestRequired: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipPermissionsFailureStatus: RequestInProgress: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipPermissionsFailureStatus: NotTransferrable: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipPermissionsFailureStatus: SessionOwnerOnly: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestStatus: RequestSent: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestStatus: AlreadyOwner: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestStatus: RequestRequiredNotSet: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestStatus: Locked: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestStatus: RequestInProgress: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestStatus: SessionOwnerOnly: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestResponseStatus: Approved: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestResponseStatus: Locked: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestResponseStatus: RequestInProgress: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestResponseStatus: CannotRequest: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipRequestResponseStatus: Denied: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipLockActions: None: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipLockActions: SetAndLock: undocumented",
-          "Unity.Netcode.NetworkObject.OwnershipLockActions: SetAndUnlock: undocumented",
-          "Unity.Netcode.NetworkObject.VisibilityDelegate: missing <returns>",
-          "Unity.Netcode.NetworkObject.SpawnDelegate: missing <returns>",
           "Unity.Netcode.CustomMessagingManager.HandleNamedMessageDelegate: missing <param name=\"senderClientId\">",
           "Unity.Netcode.CustomMessagingManager.HandleNamedMessageDelegate: missing <param name=\"messagePayload\">",
           "Unity.Netcode.GenerateSerializationForGenericParameterAttribute: .ctor(int): undocumented",