fix: remove added parameter onsynchronize (#2471)

* fix

Removing the added OnSynchronize parameter and using a protected property to avoid major version change.

* test

updating test

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Components/NetworkAnimator.cs

@@ -765,7 +765,7 @@ private void WriteSynchronizationData<T>(ref BufferSerializer<T> serializer) whe
         /// <summary>
         /// Used to synchronize newly joined clients
         /// </summary>
-        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId)
+        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer)
         {
             if (serializer.IsWriter)
             {

com.unity.netcode.gameobjects/Components/NetworkTransform.cs

@@ -1251,8 +1251,9 @@ private bool ShouldSynchronizeHalfFloat(ulong targetClientId)
         /// <typeparam name="T"></typeparam>
         /// <param name="serializer"></param>
         /// <param name="targetClientId">the clientId being synchronized (both reading and writing)</param>
-        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId = 0)
+        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer)
         {
+            var targetClientId = m_TargetIdBeingSynchronized;
             var synchronizationState = new NetworkTransformState();
 
             if (serializer.IsWriter)

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

@@ -897,11 +897,22 @@ protected NetworkObject GetNetworkObject(ulong networkId)
         /// is in read mode or write mode.
         /// </typeparam>
         /// <param name="targetClientId">the relative client identifier being synchronized</param>
-        protected virtual void OnSynchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId = 0) where T : IReaderWriter
+        protected virtual void OnSynchronize<T>(ref BufferSerializer<T> serializer) where T : IReaderWriter
         {
 
         }
 
+        /// <summary>
+        /// The relative client identifier targeted for the serialization of this <see cref="NetworkBehaviour"/> instance.
+        /// </summary>
+        /// <remarks>
+        /// This value will be set prior to <see cref="OnSynchronize{T}(ref BufferSerializer{T})"/> being invoked.
+        /// For writing (server-side), this is useful to know which client will receive the serialized data.
+        /// For reading (client-side), this will be the <see cref="NetworkManager.LocalClientId"/>.
+        /// When synchronization of this instance is complete, this value will be reset to 0
+        /// </remarks>
+        protected ulong m_TargetIdBeingSynchronized { get; private set; }
+
         /// <summary>
         /// Internal method that determines if a NetworkBehaviour has additional synchronization data to
         /// be synchronized when first instantiated prior to its associated NetworkObject being spawned.
@@ -913,6 +924,7 @@ protected virtual void OnSynchronize<T>(ref BufferSerializer<T> serializer, ulon
         /// <returns>true if it wrote synchronization data and false if it did not</returns>
         internal bool Synchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId = 0) where T : IReaderWriter
         {
+            m_TargetIdBeingSynchronized = targetClientId;
             if (serializer.IsWriter)
             {
                 // Get the writer to handle seeking and determining how many bytes were written
@@ -931,7 +943,7 @@ internal bool Synchronize<T>(ref BufferSerializer<T> serializer, ulong targetCli
                 var threwException = false;
                 try
                 {
-                    OnSynchronize(ref serializer, targetClientId);
+                    OnSynchronize(ref serializer);
                 }
                 catch (Exception ex)
                 {
@@ -947,6 +959,8 @@ internal bool Synchronize<T>(ref BufferSerializer<T> serializer, ulong targetCli
                 }
                 var finalPosition = writer.Position;
 
+                // Reset before exiting
+                m_TargetIdBeingSynchronized = default;
                 // If we wrote nothing then skip writing anything for this NetworkBehaviour
                 if (finalPosition == positionBeforeSynchronize || threwException)
                 {
@@ -1000,6 +1014,9 @@ internal bool Synchronize<T>(ref BufferSerializer<T> serializer, ulong targetCli
                     synchronizationError = true;
                 }
 
+                // Reset before exiting
+                m_TargetIdBeingSynchronized = default;
+
                 // Skip over the entry if deserialization fails
                 if (synchronizationError)
                 {

com.unity.netcode.gameobjects/Tests/Runtime/NetworkObject/NetworkObjectSynchronizationTests.cs

@@ -575,7 +575,7 @@ public override void OnNetworkSpawn()
             base.OnNetworkSpawn();
         }
 
-        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId = 0)
+        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer)
         {
             // Assign the failure type first
             m_MyCustomData.FailureType = m_FailureType.Value;
@@ -615,7 +615,7 @@ public override void OnNetworkSpawn()
             base.OnNetworkSpawn();
         }
 
-        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer, ulong targetClientId = 0)
+        protected override void OnSynchronize<T>(ref BufferSerializer<T> serializer)
         {
             serializer.SerializeNetworkSerializable(ref CustomSerializationData);
             base.OnSynchronize(ref serializer);