fix: non-authority player instance spawns with no motion (#281)

* fix

Fixes issue where a non-authority player instance could improperly initialize when two clients are connecting to the same session at the "relative" same time.
Removing spam logging on collision messages.

* update

Added change log entries.

---------

Co-authored-by: fernando-cortez <[email protected]>

Author: NoelStephensUnity

Basic/DistributedAuthoritySocialHub/Assets/Scripts/Gameplay/PlayerSpawner.cs

@@ -8,17 +8,32 @@ class PlayerSpawner : NetworkBehaviour
         [SerializeField]
         NetworkObject m_PlayerPrefab;
 
+        protected override void OnNetworkPostSpawn()
+        {
+            if (NetworkManager.LocalClient.IsSessionOwner)
+            {
+                SpawnPlayer();
+            }
+            base.OnNetworkPostSpawn();
+        }
+
         protected override void OnNetworkSessionSynchronized()
         {
             Debug.Assert(m_PlayerPrefab != null, $"Prefab reference '{nameof(m_PlayerPrefab)}' is missing or not assigned.");
+            if (!NetworkManager.LocalClient.IsSessionOwner)
+            {
+                SpawnPlayer();
+            }
+            base.OnNetworkSessionSynchronized();
+        }
 
+        private void SpawnPlayer()
+        {
             if (m_PlayerPrefab != null)
             {
                 var spawnPoint = PlayerSpawnPoints.Instance.GetRandomSpawnPoint();
                 m_PlayerPrefab.InstantiateAndSpawn(networkManager: NetworkManager, ownerClientId: NetworkManager.LocalClientId, isPlayerObject: true, position: spawnPoint.position, rotation: spawnPoint.rotation);
             }
-
-            base.OnNetworkSessionSynchronized();
         }
     }
 }

Basic/DistributedAuthoritySocialHub/Assets/Scripts/Physics/BaseObjectMotionHandler.cs

@@ -27,14 +27,18 @@ class BaseObjectMotionHandler : NetworkTransform, ICollisionHandler, IContactEve
 
         protected NetworkRigidbody NetworkRigidbody { get; private set; }
 
-        [Tooltip("Enables/Disables collision logging (based on per derived type)")]
+        [Tooltip("Enables/Disables collision logging (based on per derived type).")]
         [SerializeField]
         protected bool m_DebugCollisions;
 
-        [Tooltip("Enables/Disables damage logging (based on per derived type)")]
+        [Tooltip("Enables/Disables damage logging (based on per derived type).")]
         [SerializeField]
         protected bool m_DebugDamage;
 
+        [Tooltip("Enables/Disables general message logging (it is verbose and can generate a lot of messages).")]
+        [SerializeField]
+        protected bool m_GeneralLogMessages;
+
         [Tooltip("Add all colliders to this list that will be used to detect collisions (exclude triggers).")]
         [SerializeField]
         List<Collider> m_Colliders;
@@ -193,7 +197,10 @@ public void HandleCollisionRpc(CollisionMessageInfo collisionMessage, RpcParams
             // If authority changes while this message is in flight, forward it to the new authority
             if (!HasAuthority)
             {
-                LogMessage($"[HandleCollisionRpc][Not Owner][Routing Collision][{name}] Routing to Client-{OwnerClientId}");
+                if (m_GeneralLogMessages)
+                {
+                    LogMessage($"[HandleCollisionRpc][Not Owner][Routing Collision][{name}] Routing to Client-{OwnerClientId}");
+                }
                 SendCollisionMessage(m_CollisionMessage);
                 return;
             }

Basic/DistributedAuthoritySocialHub/Assets/Scripts/Player/AvatarTransform.cs

@@ -27,19 +27,19 @@ class AvatarTransform : PhysicsObjectMotion, INetworkUpdateSystem
         NetworkVariable<FixedString32Bytes> m_PlayerName = new NetworkVariable<FixedString32Bytes>(string.Empty, readPerm: NetworkVariableReadPermission.Everyone, writePerm: NetworkVariableWritePermission.Owner);
         NetworkVariable<FixedString32Bytes> m_PlayerId = new NetworkVariable<FixedString32Bytes>(string.Empty, readPerm: NetworkVariableReadPermission.Everyone, writePerm: NetworkVariableWritePermission.Owner);
 
-
         public override void OnNetworkSpawn()
         {
+            // Always invoke base.OnNetworkSpawn before any other script.
+            base.OnNetworkSpawn();
             gameObject.name = $"[Client-{OwnerClientId}]{name}";
 
             m_TopUIController = FindFirstObjectByType<PlayersTopUIController>();
             m_PlayerName.OnValueChanged += OnPlayerNameChanged;
             m_PlayerId.OnValueChanged += OnPlayerIdChanged;
             OnPlayerNameChanged(string.Empty, m_PlayerName.Value);
 
-            if (!HasAuthority)
+            if (!CanCommitToTransform)
             {
-                base.OnNetworkSpawn();
                 return;
             }
 
@@ -66,8 +66,6 @@ public override void OnNetworkSpawn()
             {
                 Debug.LogError("CameraControl not found on the Main Camera or Main Camera is missing.");
             }
-
-            base.OnNetworkSpawn();
         }
 
         public override void OnNetworkDespawn()
@@ -114,12 +112,12 @@ void OnTransformUpdate()
 
         void OnPlayerNameChanged(FixedString32Bytes previousValue, FixedString32Bytes newValue)
         {
-            m_TopUIController.AddOrUpdatePlayer(gameObject, newValue.Value,m_PlayerId.Value.Value);
+            m_TopUIController.AddOrUpdatePlayer(gameObject, newValue.Value, m_PlayerId.Value.Value);
         }
 
         void OnPlayerIdChanged(FixedString32Bytes previousValue, FixedString32Bytes newValue)
         {
-            m_TopUIController.AddOrUpdatePlayer(gameObject, m_PlayerName.Value.Value,newValue.Value);
+            m_TopUIController.AddOrUpdatePlayer(gameObject, m_PlayerName.Value.Value, newValue.Value);
         }
 
         public void NetworkUpdate(NetworkUpdateStage updateStage)

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [unreleased] yyyy-mm-dd
 
+### Distributed Authority Social Hub
+
+#### Fixed
+- Fixed issue where a non-authority player instance could improperly initialize when two clients are connecting to the same session at the "relative" same time. (#281)
+- Fixed issue with spam logging on collision messages. (#281)
+
 ### Multiplayer Use Cases
 
 #### Added