AnticipatedNetworkTransform corrections

Author: michalChrobot

com.unity.netcode.gameobjects/Runtime/Components/AnticipatedNetworkTransform.cs

@@ -286,6 +286,9 @@ private void ProcessSmoothing()
         // TODO: This does not handle OnFixedUpdate
         // This requires a complete overhaul in this class to switch between using
         // NetworkRigidbody's position and rotation values.
+        /// <summary>
+        /// Processes updates for the network transform, including smoothing interpolation
+        /// </summary>
         public override void OnUpdate()
         {
             ProcessSmoothing();
@@ -422,6 +425,9 @@ protected internal override void InternalOnNetworkPostSpawn()
             }
         }
 
+        /// <summary>
+        /// Called when the NetworkObject is spawned to initialize network transform functionality
+        /// </summary>
         public override void OnNetworkSpawn()
         {
             if (NetworkManager.DistributedAuthorityMode)
@@ -445,6 +451,9 @@ public override void OnNetworkSpawn()
             NetworkManager.AnticipationSystem.AllAnticipatedObjects.Add(m_AnticipatedObject);
         }
 
+        /// <summary>
+        /// Called when the NetworkObject is despawned to cleanup network transform resources
+        /// </summary>
         public override void OnNetworkDespawn()
         {
             if (m_AnticipatedObject != null)
@@ -459,6 +468,9 @@ public override void OnNetworkDespawn()
             base.OnNetworkDespawn();
         }
 
+        /// <summary>
+        /// Called when the component is being destroyed to perform final cleanup
+        /// </summary>
         public override void OnDestroy()
         {
             if (m_AnticipatedObject != null)
@@ -510,19 +522,30 @@ public void Smooth(TransformState from, TransformState to, float durationSeconds
             m_CurrentSmoothTime = 0;
         }
 
+        /// <summary>
+        /// Called before the transform state is updated with new network data
+        /// </summary>
         protected override void OnBeforeUpdateTransformState()
         {
             // this is called when new data comes from the server
             m_LastAuthorityUpdateCounter = NetworkManager.AnticipationSystem.LastAnticipationAck;
             m_OutstandingAuthorityChange = true;
         }
 
+        /// <summary>
+        /// Called when new transform state data is received from the network
+        /// </summary>
+        /// <param name="oldState">The previous network transform state</param>
+        /// <param name="newState">The new network transform state to apply</param>
         protected override void OnNetworkTransformStateUpdated(ref NetworkTransformState oldState, ref NetworkTransformState newState)
         {
             base.OnNetworkTransformStateUpdated(ref oldState, ref newState);
             ApplyAuthoritativeState();
         }
 
+        /// <summary>
+        /// Called after the transform has been updated with new values
+        /// </summary>
         protected override void OnTransformUpdated()
         {
             if (CanCommitToTransform || m_AnticipatedObject == null)

pvpExceptions.json

@@ -7,47 +7,50 @@
       },
       "PVP-151-1": {
         "errors": [
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnUpdate(): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnNetworkSpawn(): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnNetworkDespawn(): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnDestroy(): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnBeforeUpdateTransformState(): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnNetworkTransformStateUpdated(ref NetworkTransformState, ref NetworkTransformState): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform: void OnTransformUpdated(): undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform.TransformState: undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform.TransformState: Position: undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform.TransformState: Rotation: undocumented",
-          "Unity.Netcode.Components.AnticipatedNetworkTransform.TransformState: Scale: undocumented",          
           "Unity.Netcode.ConnectionEventData: EventType: undocumented",
+          
           "Unity.Netcode.RpcException: undocumented",
           "Unity.Netcode.RpcException: .ctor(string): undocumented",
+          
           "Unity.Netcode.NetworkManager: CurrentSessionOwner: undocumented",
           "Unity.Netcode.NetworkManager: void NetworkUpdate(NetworkUpdateStage): undocumented",
           "Unity.Netcode.NetworkManager.ReanticipateDelegate: undocumented",
+          
           "Unity.Netcode.NetworkObject: void SetSceneObjectStatus(bool): undocumented",
+          
           "Unity.Netcode.CustomMessagingManager.HandleNamedMessageDelegate: missing <param name=\"senderClientId\">",
           "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",
           "Unity.Netcode.NetworkVariable<T>: void OnInitialize(): undocumented",
           "Unity.Netcode.NetworkVariable<T>: bool CheckDirtyState(bool): missing <returns>",
           "Unity.Netcode.NetworkVariable<T>: void Dispose(): undocumented",
           "Unity.Netcode.NetworkVariable<T>: void Finalize(): undocumented",
           "Unity.Netcode.NetworkVariable<T>.CheckExceedsDirtinessThresholdDelegate: undocumented",
+          
           "Unity.Netcode.NetworkVariableUpdateTraits: undocumented",
           "Unity.Netcode.NetworkVariableUpdateTraits: MinSecondsBetweenUpdates: undocumented",
           "Unity.Netcode.NetworkVariableUpdateTraits: MaxSecondsBetweenUpdates: undocumented",
+          
           "Unity.Netcode.NetworkVariableBase: NetworkBehaviour GetBehaviour(): undocumented",
           "Unity.Netcode.NetworkVariableBase: void MarkNetworkBehaviourDirty(): undocumented",
+          
           "Unity.Netcode.NetworkVariableSerialization<T>.EqualsDelegate: missing <param name=\"a\">",
           "Unity.Netcode.NetworkVariableSerialization<T>.EqualsDelegate: missing <param name=\"b\">",
           "Unity.Netcode.NetworkVariableSerialization<T>.EqualsDelegate: missing <returns>",
+          
           "Unity.Netcode.UserNetworkVariableSerialization<T>.WriteDeltaDelegate: missing <param name=\"previousValue\">",
           "Unity.Netcode.UserNetworkVariableSerialization<T>.DuplicateValueDelegate: missing <param name=\"duplicatedValue\">",
+          
           "Unity.Netcode.NetworkSpawnManager: void Finalize(): undocumented",
+          
           "Unity.Netcode.NetworkTransport.TransportEventDelegate: missing <param name=\"eventType\">",
           "Unity.Netcode.NetworkTransport.TransportEventDelegate: missing <param name=\"clientId\">",
           "Unity.Netcode.NetworkTransport.TransportEventDelegate: missing <param name=\"payload\">",