Merge branch 'develop-2.0.0' into fix/networktransform-autoswitchspace-forcing-updates-localspace

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -12,6 +12,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 
 - Added NetworkRigidbody documentation section. (#3664)
 - Clicking on the Help icon in the inspector will now redirect to the relevant documentation. (#3663)
+- 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)
 
 ### Changed
 

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

@@ -4,5 +4,4 @@ Use the samples in this section to learn how to use Netcode for GameObjects in y
 
 | **Topic**                       | **Description**                  |
 | :------------------------------ | :------------------------------- |
-| **[NetworkBehaviour](components/core/networkbehaviour.md)** | [NetworkBehaviour](https://docs.unity3d.com/Packages/com.unity.netcode.gameobjects@latest?subfolder=/api/Unity.Netcode.NetworkBehaviour.html) is an abstract class that derives from [MonoBehaviour](https://docs.unity3d.com/ScriptReference/MonoBehaviour.html) and is primarily used to create unique netcode or game logic. To replicate any netcode-aware properties or send and receive RPCs, a [GameObject](https://docs.unity3d.com/Manual/GameObjects.html) must have a [NetworkObject](components/core/networkobject.md) component and at least one NetworkBehaviour component. |
-| **[Synchronize](components/core/networkbehaviour-synchronize.md)** | You can use NetworkBehaviours to synchronize settings before, during, and after spawning NetworkObjects. |
+| **[Bossroom](samples/bossroom/bossroom-landing.md)** | The Boss Room sample is a multiplayer game that demonstrates how to use Netcode for GameObjects to create a networked game. It provides a complete example of how to implement various features such as player movement, combat, and game state management in a multiplayer environment. |

com.unity.netcode.gameobjects/Documentation~/samples/bitesize/bitesize-spaceshooter.md

@@ -4,15 +4,15 @@ The [2D Space Shooter Project](https://github.com/Unity-Technologies/com.unity.m
 
 ## Server Authoritative Physics Movement
 
-The movement in 2DSpaceShooter is physics based. The player object is a dynamic rigidbody and can collide with other players or asteroids. Physics in multiplayer games can be hard to get right. For simplicity, 2DSpaceShooter runs all movement and physics just on the server-side.
+The movement in 2DSpaceShooter is physics based. The player object is a [dynamic Rigidbody](https://docs.unity3d.com/Documentation/Manual/2d-physics/rigidbody/body-types/dynamic/dynamic-body-type-reference.html) and can collide with other players or asteroids. Physics in multiplayer games can be hard to get right. For simplicity, 2DSpaceShooter runs all movement and physics just on the server-side.
 
 The client sends inputs in the form of RPCs to the server. The server then uses those inputs to adjust the throttle and turn values of the player.
 
 This method of running physics makes sure that there are no desyncs or other physics issues between the client and server, but it introduces more latency.
 
 ## Player Health
 
-2DSpaceShooter uses `NetworkVariable`s to track the players health and energy. Both variables are server authoritative, only the host or server can make changes to them. The client draws the player's health bar simply by accessing the value of the `NetworkVariable`.
+2DSpaceShooter uses [NetworkVariables](../../basics/networkvariable.md) to track the players health and energy. Both variables are server authoritative, only the host or server can make changes to them. The client draws the player's health bar simply by accessing the value of the `NetworkVariable`.
 
 For example:
 
@@ -34,9 +34,9 @@ https://github.com/Unity-Technologies/com.unity.multiplayer.samples.bitesize/blo
 
 ## NetworkObject Pooling
 
-The `2DSpaceShooter` object creates many objects dynamically at runtime including bullets, asteroids, and pickups. 2DSpaceShooter uses object pooling to avoid performance issues of instantiating and destroying Unity Objects all the time and creating allocations in the process.
+The `2DSpaceShooter` object creates many objects dynamically at runtime including bullets, asteroids, and pickups. 2DSpaceShooter uses [object pooling](../../advanced-topics/object-pooling.md) to avoid performance issues of instantiating and destroying Unity Objects all the time and creating allocations in the process.
 
-2DSpaceShooter uses the NetworkObjectPool script, which can be found in the Community Contributions Repository.
+2DSpaceShooter uses the NetworkObjectPool script, which can be found in the [Community Contributions Repository](https://github.com/Unity-Technologies/multiplayer-community-contributions).
 
 ![pool img](../../images/bitesize/invader-networkobjectpool.png)
 

com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Runtime.CompilerServices;
 using Unity.Collections;
 
 namespace Unity.Netcode
@@ -597,45 +598,60 @@ public void RemoveAt(int index)
         }
 
         /// <summary>
-        /// Gets or sets the element at the specified index in the <see cref="NetworkList{T}"/>.
+        /// Sets the element at the specified index in the <see cref="NetworkList{T}"/>.
         /// </summary>
         /// <remarks>
-        /// This method checks for write permissions before setting the value.
+        /// This method checks for write permissions and equality before setting and updating the value.
         /// </remarks>
-        /// <param name="index">The zero-based index of the element to get or set.</param>
-        /// <value>The element at the specified index.</value>
-        public T this[int index]
+        /// <param name="index">The zero-based index of the element to set.</param>
+        /// <param name="value">The new value to set at the given index</param>
+        /// <param name="forceUpdate">
+        /// Ignores the equality check when setting the value.
+        /// This option can send unnecessary updates to all clients when the value hasn't changed.
+        /// </param>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public void Set(int index, T value, bool forceUpdate = false)
         {
-            get => m_List[index];
-            set
+            // check write permissions
+            if (CannotWrite)
             {
-                // check write permissions
-                if (CannotWrite)
-                {
-                    LogWritePermissionError();
-                    return;
-                }
+                LogWritePermissionError();
+                return;
+            }
 
-                var previousValue = m_List[index];
+            var previousValue = m_List[index];
 
-                // Only trigger an event if the value has changed
-                if (NetworkVariableSerialization<T>.AreEqual(ref previousValue, ref value))
-                {
-                    return;
-                }
+            // Only trigger an event if the value has changed
+            if (!forceUpdate && NetworkVariableSerialization<T>.AreEqual(ref previousValue, ref value))
+            {
+                return;
+            }
 
-                m_List[index] = value;
+            m_List[index] = value;
 
-                var listEvent = new NetworkListEvent<T>()
-                {
-                    Type = NetworkListEvent<T>.EventType.Value,
-                    Index = index,
-                    Value = value,
-                    PreviousValue = previousValue
-                };
+            var listEvent = new NetworkListEvent<T>()
+            {
+                Type = NetworkListEvent<T>.EventType.Value,
+                Index = index,
+                Value = value,
+                PreviousValue = previousValue
+            };
 
-                HandleAddListEvent(listEvent);
-            }
+            HandleAddListEvent(listEvent);
+        }
+
+        /// <summary>
+        /// Gets or sets the element at the specified index in the <see cref="NetworkList{T}"/>.
+        /// </summary>
+        /// <remarks>
+        /// This method checks for write permissions before setting the value.
+        /// </remarks>
+        /// <param name="index">The zero-based index of the element to get or set.</param>
+        /// <value>The element at the specified index.</value>
+        public T this[int index]
+        {
+            get => m_List[index];
+            set => Set(index, value);
         }
 
         /// <summary>