Merge branch 'fix/networktransform-autoswitchspace-forcing-updates-localspace' into doc/addition-to-3664-order-of-operations

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -10,21 +10,17 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 ### Added
 
-- Added a `Set` function onto `NetworkList` that takes an optional parameter that forces an update to be processed even if the current value is equal to the previous value. (#3690)
 - Added NetworkRigidbody documentation section. (#3664)
-- Clicking on the Help icon in the inspector will now redirect to the relevant documentation. (#3663)
-- `NetworkSceneManager` as an internal wrapper for the `SceneManager.Scene.handle` and swapped all places that use an `int` to represent a `Scene.handle` to instead use the `NetworkSceneManager`. (#3647)
 
 ### Changed
 
 - The `NetworkManager` functions `GetTransportIdFromClientId` and `GetClientIdFromTransportId` will now return `ulong.MaxValue` when the clientId or transportId do not exist. (#3707)
-- Improved performance of the NetworkVariable. (#3683)
-- Improved performance around the NetworkBehaviour component. (#3687)
 - Changed NetworkShow to send a message at the end of the frame and force a NetworkVariable synchronization prior to generating the CreateObjectMessage as opposed to waiting until the next network tick to synchronize the show with the update to NetworkVariables. (#3664)
 - Changed NetworkTransform now synchronizes `NetworkTransform.SwitchTransformSpaceWhenParented` when it is updated by the motion model authority. (#3664)
 - Changed when NetworkObjects pending to be shown to clients can now occur on partial network ticks. If any pending NetworkObjects pending to be shown to clients happens to be ready on a new network tick they still are shown after network variable deltas have been processed. (#3664)
 - Changed the default `NetworkDelivery` used by all messages is now reliable fragmented sequenced with the exception of named, unnamed, and any messages sent with a user specified network delivery type. This assures certain order of operations to be preserved when same call-stack changes are applied to a newly spawned, authority side, NetworkObject. (#3664)
 - Changed NetworkTransform documentation to better reflect the Teleport methods intended usage along with updates to NetworkObject and physics areas of the documentation. (#3664)
+- The first session owner no longer sends two synchronization messages to the service. (#3563)
 
 ### Deprecated
 
@@ -35,8 +31,6 @@ Additional documentation and release notes are available at [Multiplayer Documen
 ### Fixed
 
 - Multiple disconnect events from the same transport will no longer disconnect the host. (#3707)
-- Distributed authority clients no longer send themselves in the `ClientIds` list when sending a `ChangeOwnershipMessage`. (#3687)
-- Made a variety of small performance improvements. (#3683)
 - Fixed NetworkTransform state synchronization issue when `NetworkTransform.SwitchTransformSpaceWhenParented` is enabled and the associated NetworkObject is parented multiple times in a single frame or within a couple of frames. (#3664)
 - Fixed issue when spawning, parenting, and immediately re-parenting when `NetworkTransform.SwitchTransformSpaceWhenParented` is enabled. (#3664)
 - Fixed issue where the disconnect event and provided message was too generic to know why the disconnect occurred. (#3551)

com.unity.netcode.gameobjects/Documentation~/TableOfContents.md

@@ -35,9 +35,6 @@
     * [NetworkRigidbody](components/helper/networkrigidbody.md)
     * [NetworkTransform](components/helper/networktransform.md)
   * [Physics](advanced-topics/physics.md)
-* [Ownership and authority](ownership-authority.md)
-  * [Understanding ownership and authority](basics/ownership.md)
-  * [Ownership race conditions](basics/race-conditions.md)
 * [Spawning and despawning](spawn-despawn.md)
   * [Object spawning](basics/object-spawning.md)
   * [Network prefab handler](advanced-topics/network-prefab-handler.md)

com.unity.netcode.gameobjects/Documentation~/components/core/networkbehaviour.md

@@ -66,7 +66,8 @@ Dynamically spawned | In-scene placed (disabled NetworkBehaviour components)
 `OnNetworkSpawn`      | `OnNetworkSpawn`
 `Start`               | `Start` (invoked when disabled NetworkBehaviour components are enabled)
 
-> [!NOTE] Parenting, inactive GameObjects, and NetworkBehaviour components
+> [!NOTE]
+> Parenting, inactive GameObjects, and NetworkBehaviour components<br />
 > If you have child GameObjects that are not active in the hierarchy but are nested under an active GameObject with an attached NetworkObject component, then the inactive child GameObjects will not be included when the NetworkObject is spawned. This applies for the duration of the NetworkObject's spawned lifetime. If you want all child NetworkBehaviour components to be included in the spawn process, then make sure their respective GameObjects are active in the hierarchy before spawning the NetworkObject. Alternatively, you can just disable the NetworkBehaviour component(s) individually while leaving their associated GameObject active.
 > It's recommended to disable a NetworkBehaviour component rather than the GameObject itself.
 
@@ -165,7 +166,8 @@ Each NetworkBehaviour has a virtual `OnDestroy` method that you can override to
         }
 ```
 
-> [!NOTE] Destroying the GameObject
+> [!NOTE]
+> Destroying the GameObject<br />
 > When destroying a NetworkObject from within an associated NetworkBehaviour component script, you should always destroy the `NetworkObject.gameObject` and not the `NetworkBehaviour.gameObject` in case the NetworkBehaviour is located on a child GameObject nested under the NetworkObject's GameObject.
 
 ### Despawn process and invocation order

com.unity.netcode.gameobjects/Documentation~/components/core/networkobject.md

@@ -41,14 +41,14 @@ The default `NetworkObject.Spawn` method assumes server-side ownership:
 GetComponent<NetworkObject>().Spawn();
 ```
 
-To spawn NetworkObjects with ownership use the following:
+To spawn a `NetworkObject` that is [owned](../../terms-concepts/ownership.md) by a different game client than the one doing the spawning, use the following:
 
 ```csharp
 GetComponent<NetworkObject>().SpawnWithOwnership(clientId);
 ```
 > [!NOTE]
-> When using the `SpawnWithOwnership` method, be aware that any component that has owner-specific checks to perform specific actions won't be invoked on the spawn authority  side during the spawn sequence. The spawn authority is the server when using a client-server network topology, and can be any client when using a distributed authority network topology. Using `SpawnWithOwnership` can impact things like [NetworkTransform](../helper/networktransform.md) when using an owner authority motion model, and potentially provide undesired parenting artifacts and/or impact your own scripts if you are planning to have the spawn authority make any further post-spawn adjustments within the same frame.
-> To avoid potential issues, it's recommended to use `Spawn`, where the spawn authority starts as the owner throughout the spawn sequence, makes adjustments post-spawn, and then immediately follow with a call to `ChangeOwnership`.
+> The `SpawnWithOwnership` method allows a game client to spawn an object that it doesn't own. This means any owner-specific checks during the spawn sequence will not be invoked on the spawn authority side. Using `SpawnWithOwnership` can result in unexpected behavior if the spawn authority makes any additional post-spawn adjustments within the same frame.
+> To avoid potential issues, it's recommended to use `Spawn` if the spawn authority needs to make any adjustments post-spawn. After adjusting, the spawn authority can immediately follow with a call to `ChangeOwnership`.
 
 To change ownership, use the `ChangeOwnership` method:
 
@@ -62,7 +62,7 @@ To give ownership back to the server use the `RemoveOwnership` method:
 GetComponent<NetworkObject>().RemoveOwnership();
 ```
 > [!NOTE]
-> Using `RemoveOwnership` in a distributed authority network topology isn't recommended.
+> `RemoveOwnership` isn't supported when using a [distributed authority network topology](../../terms-concepts/distributed-authority.md).
 
 
 To see if the local client is the owner of a NetworkObject, you can check the [`NetworkBehaviour.IsOwner`](https://docs.unity3d.com/Packages/com.unity.netcode.gameobjects@latest?subfolder=/api/Unity.Netcode.NetworkBehaviour.IsOwner.html) property.

com.unity.netcode.gameobjects/Documentation~/components/helper/networkanimator.md

@@ -121,5 +121,6 @@ public void SetPlayerJumping(bool isJumping)
 }
 ```
 
-> [!NOTE] Changing meshes
+> [!NOTE]
+> Changing meshes<br/>
 > When swapping a skinned mesh with another reparented skinned mesh, you can invoke the `Rebind ` method on the `Animator` components: `Animator.Rebind()`.

com.unity.netcode.gameobjects/Documentation~/images/bestpractices.png

@@ -1515,7 +1515,7 @@ internal bool SynchronizeScale
         /// <remarks>
         /// Only works with <see cref="NetworkTransform"/> components that are not paired with a <see cref="NetworkRigidbody"/> or <see cref="NetworkRigidbody2D"/> component that is configured to use the rigid body for motion.<br />
         /// <see cref="TickSyncChildren"/> will automatically be set when this is enabled.
-        /// This field is auto-synchronize with non-authority clients if changed by the authority instance.
+        /// This field is auto-synchronized with non-authority clients when changed by the authority instance.
         /// </remarks>
         [Tooltip("When enabled, NetworkTransform controls world or local space settings while also providing smooth parenting transitions." +
             "When disabled, world or local space settings have to be adjusted by script or in the inspector view.")]

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

@@ -236,7 +236,11 @@ internal void SetSessionOwner(ulong sessionOwner)
             OnSessionOwnerPromoted?.Invoke(sessionOwner);
         }
 
+#if ENABLE_SESSIONOWNER_PROMOTION_NOTIFICATION
+        public void PromoteSessionOwner(ulong clientId)
+#else
         internal void PromoteSessionOwner(ulong clientId)
+#endif
         {
             if (!DistributedAuthorityMode)
             {
@@ -253,10 +257,18 @@ internal void PromoteSessionOwner(ulong clientId)
             {
                 SessionOwner = clientId,
             };
-            var clients = ConnectionManager.ConnectedClientIds.Where(c => c != LocalClientId).ToArray();
-            foreach (var targetClient in clients)
+            var delivery = MessageDeliveryType<SessionOwnerMessage>.DefaultDelivery;
+            if (CMBServiceConnection)
             {
-                ConnectionManager.SendMessage(ref sessionOwnerMessage, MessageDeliveryType<SessionOwnerMessage>.DefaultDelivery, targetClient);
+                ConnectionManager.SendMessage(ref sessionOwnerMessage, delivery, ServerClientId);
+            }
+            else
+            {
+                var clients = ConnectionManager.ConnectedClientIds.Where(c => c != LocalClientId).ToArray();
+                foreach (var targetClient in clients)
+                {
+                    ConnectionManager.SendMessage(ref sessionOwnerMessage, delivery, targetClient);
+                }
             }
         }
 

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

@@ -10,8 +10,8 @@ internal static class HelpUrls
         public const string NetworkManager = k_BaseManualUrl + "components/core/networkmanager.html";
         public const string NetworkObject = k_BaseManualUrl + "components/core/networkobject.html";
         public const string NetworkAnimator = k_BaseManualUrl + "components/helper/networkanimator.html";
-        public const string NetworkRigidbody = k_BaseManualUrl + "advanced-topics/physics.html#networkrigidbody";
-        public const string NetworkRigidbody2D = k_BaseManualUrl + "advanced-topics/physics.html#networkrigidbody2d";
+        public const string NetworkRigidbody = k_BaseManualUrl + "components/helper/networkrigidbody.html";
+        public const string NetworkRigidbody2D = k_BaseManualUrl + "components/helper/networkrigidbody.html";
         public const string RigidbodyContactEventManager = k_BaseApiUrl + ".Components.RigidbodyContactEventManager.html";
         public const string NetworkTransform = k_BaseManualUrl + "components/helper/networktransform.html";
         public const string AnticipatedNetworkTransform = k_BaseManualUrl + "advanced-topics/client-anticipation.html";

com.unity.netcode.gameobjects/Runtime/HelpUrls.cs

@@ -373,21 +373,18 @@ public void Handle(ref NetworkContext context)
 
                     if (!networkManager.SceneManager.IsRestoringSession)
                     {
-                        // Synchronize the service with the initial session owner's loaded scenes and spawned objects
-                        networkManager.SceneManager.SynchronizeNetworkObjects(NetworkManager.ServerClientId, true);
-
                         // Spawn any in-scene placed NetworkObjects
                         networkManager.SpawnManager.ServerSpawnSceneObjectsOnStartSweep();
 
+                        // Synchronize the service with the initial session owner's loaded scenes and spawned objects
+                        networkManager.SceneManager.SynchronizeNetworkObjects(NetworkManager.ServerClientId, true);
+
                         // Spawn the local player of the session owner
                         if (networkManager.AutoSpawnPlayerPrefabClientSide)
                         {
                             networkManager.ConnectionManager.CreateAndSpawnPlayer(OwnerClientId);
                         }
 
-                        // Synchronize the service with the initial session owner's loaded scenes and spawned objects
-                        networkManager.SceneManager.SynchronizeNetworkObjects(NetworkManager.ServerClientId, true);
-
                         // With scene management enabled and since the session owner doesn't send a scene event synchronize to itself,
                         // we need to notify the session owner that everything should be synchronized/spawned at this time.
                         networkManager.SpawnManager.NotifyNetworkObjectsSynchronized();