com.unity.netcode.gameobjects@2.1.1
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). ## [2.1.1] - 2024-10-18 ### Added - Added ability to edit the `NetworkConfig.AutoSpawnPlayerPrefabClientSide` within the inspector view. (#3097) - Added `IContactEventHandlerWithInfo` that derives from `IContactEventHandler` that can be updated per frame to provide `ContactEventHandlerInfo` information to the `RigidbodyContactEventManager` when processing collisions. (#3094) - `ContactEventHandlerInfo.ProvideNonRigidBodyContactEvents`: When set to true, non-`Rigidbody` collisions with the registered `Rigidbody` will generate contact event notifications. (#3094) - `ContactEventHandlerInfo.HasContactEventPriority`: When set to true, the `Rigidbody` will be prioritized as the instance that generates the event if the `Rigidbody` colliding does not have priority. (#3094) - Added a static `NetworkManager.OnInstantiated` event notification to be able to track when a new `NetworkManager` instance has been instantiated. (#3088) - Added a static `NetworkManager.OnDestroying` event notification to be able to track when an existing `NetworkManager` instance is being destroyed. (#3088) ### Fixed - Fixed issue where `NetworkPrefabProcessor` would not mark the prefab list as dirty and prevent saving the `DefaultNetworkPrefabs` asset when only imports or only deletes were detected.(#3103) - Fixed an issue where nested `NetworkTransform` components in owner authoritative mode cleared their initial settings on the server, causing improper synchronization. (#3099) - Fixed issue with service not getting synchronized with in-scene placed `NetworkObject` instances when a session owner starts a `SceneEventType.Load` event. (#3096) - Fixed issue with the in-scene network prefab instance update menu tool where it was not properly updating scenes when invoked on the root prefab instance. (#3092) - Fixed an issue where newly synchronizing clients would always receive current `NetworkVariable` values, potentially causing issues with collections if there were pending updates. Now, pending state updates serialize previous values to avoid duplicates on new clients. (#3081) - Fixed issue where changing ownership would mark every `NetworkVariable` dirty. Now, it will only mark any `NetworkVariable` with owner read permissions as dirty and will send/flush any pending updates to all clients prior to sending the change in ownership message. (#3081) - Fixed an issue where transferring ownership of `NetworkVariable` collections didn't update the new owner’s previous value, causing the last added value to be detected as a change during additions or removals. (#3081) - Fixed issue where a client (or server) with no write permissions for a `NetworkVariable` using a standard .NET collection type could still modify the collection which could cause various issues depending upon the modification and collection type. (#3081) - Fixed issue where applying the position and/or rotation to the `NetworkManager.ConnectionApprovalResponse` when connection approval and auto-spawn player prefab were enabled would not apply the position and/or rotation when the player prefab was instantiated. (#3078) - Fixed issue where `NetworkObject.SpawnWithObservers` was not being honored when spawning the player prefab. (#3077) - Fixed issue with the client count not being correct on the host or server side when a client disconnects itself from a session. (#3075) ### Changed - Changed `NetworkConfig.AutoSpawnPlayerPrefabClientSide` is no longer automatically set when starting `NetworkManager`. (#3097) - Updated `NetworkVariableDeltaMessage` so the server now forwards delta state updates from clients immediately, instead of waiting until the end of the frame or the next network tick. (#3081)
This commit is contained in:
Unity Technologies
@@ -2,6 +2,7 @@
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
using NUnit.Framework;
|
||||
using Unity.Netcode.Components;
|
||||
using Unity.Netcode.TestHelpers.Runtime;
|
||||
@@ -539,5 +540,279 @@ namespace Unity.Netcode.RuntimeTests
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
[TestFixture(HostOrServer.DAHost, NetworkTransform.AuthorityModes.Owner)] // Validate the NetworkTransform owner authoritative mode fix using distributed authority
|
||||
[TestFixture(HostOrServer.Host, NetworkTransform.AuthorityModes.Server)] // Validate we have not impacted NetworkTransform server authoritative mode
|
||||
[TestFixture(HostOrServer.Host, NetworkTransform.AuthorityModes.Owner)] // Validate the NetworkTransform owner authoritative mode fix using client-server
|
||||
internal class NestedNetworkTransformTests : IntegrationTestWithApproximation
|
||||
{
|
||||
private const int k_NestedChildren = 5;
|
||||
protected override int NumberOfClients => 2;
|
||||
|
||||
private GameObject m_SpawnObject;
|
||||
|
||||
private NetworkTransform.AuthorityModes m_AuthorityMode;
|
||||
|
||||
private StringBuilder m_ErrorLog = new StringBuilder();
|
||||
|
||||
private List<NetworkManager> m_NetworkManagers = new List<NetworkManager>();
|
||||
private List<GameObject> m_SpawnedObjects = new List<GameObject>();
|
||||
|
||||
public NestedNetworkTransformTests(HostOrServer hostOrServer, NetworkTransform.AuthorityModes authorityMode) : base(hostOrServer)
|
||||
{
|
||||
m_AuthorityMode = authorityMode;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a player prefab with several nested NetworkTransforms
|
||||
/// </summary>
|
||||
protected override void OnCreatePlayerPrefab()
|
||||
{
|
||||
var networkTransform = m_PlayerPrefab.AddComponent<NetworkTransform>();
|
||||
networkTransform.AuthorityMode = m_AuthorityMode;
|
||||
var parent = m_PlayerPrefab;
|
||||
// Add several nested NetworkTransforms
|
||||
for (int i = 0; i < k_NestedChildren; i++)
|
||||
{
|
||||
var nestedChild = new GameObject();
|
||||
nestedChild.transform.parent = parent.transform;
|
||||
var nestedNetworkTransform = nestedChild.AddComponent<NetworkTransform>();
|
||||
nestedNetworkTransform.AuthorityMode = m_AuthorityMode;
|
||||
nestedNetworkTransform.InLocalSpace = true;
|
||||
parent = nestedChild;
|
||||
}
|
||||
base.OnCreatePlayerPrefab();
|
||||
}
|
||||
|
||||
private void RandomizeObjectTransformPositions(GameObject gameObject)
|
||||
{
|
||||
var networkObject = gameObject.GetComponent<NetworkObject>();
|
||||
Assert.True(networkObject.ChildNetworkBehaviours.Count > 0);
|
||||
|
||||
foreach (var networkTransform in networkObject.NetworkTransforms)
|
||||
{
|
||||
networkTransform.gameObject.transform.position = GetRandomVector3(-15.0f, 15.0f);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Randomizes each player's position when validating distributed authority
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
private GameObject FetchLocalPlayerPrefabToSpawn()
|
||||
{
|
||||
RandomizeObjectTransformPositions(m_PlayerPrefab);
|
||||
return m_PlayerPrefab;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Randomizes the player position when validating client-server
|
||||
/// </summary>
|
||||
/// <param name="connectionApprovalRequest"></param>
|
||||
/// <param name="connectionApprovalResponse"></param>
|
||||
private void ConnectionApprovalHandler(NetworkManager.ConnectionApprovalRequest connectionApprovalRequest, NetworkManager.ConnectionApprovalResponse connectionApprovalResponse)
|
||||
{
|
||||
connectionApprovalResponse.Approved = true;
|
||||
connectionApprovalResponse.CreatePlayerObject = true;
|
||||
RandomizeObjectTransformPositions(m_PlayerPrefab);
|
||||
connectionApprovalResponse.Position = GetRandomVector3(-15.0f, 15.0f);
|
||||
}
|
||||
|
||||
protected override void OnServerAndClientsCreated()
|
||||
{
|
||||
// Create a prefab to spawn with each NetworkManager as the owner
|
||||
m_SpawnObject = CreateNetworkObjectPrefab("SpawnObj");
|
||||
var networkTransform = m_SpawnObject.AddComponent<NetworkTransform>();
|
||||
networkTransform.AuthorityMode = m_AuthorityMode;
|
||||
var parent = m_SpawnObject;
|
||||
// Add several nested NetworkTransforms
|
||||
for (int i = 0; i < k_NestedChildren; i++)
|
||||
{
|
||||
var nestedChild = new GameObject();
|
||||
nestedChild.transform.parent = parent.transform;
|
||||
var nestedNetworkTransform = nestedChild.AddComponent<NetworkTransform>();
|
||||
nestedNetworkTransform.AuthorityMode = m_AuthorityMode;
|
||||
nestedNetworkTransform.InLocalSpace = true;
|
||||
parent = nestedChild;
|
||||
}
|
||||
|
||||
if (m_DistributedAuthority)
|
||||
{
|
||||
if (!UseCMBService())
|
||||
{
|
||||
m_ServerNetworkManager.OnFetchLocalPlayerPrefabToSpawn = FetchLocalPlayerPrefabToSpawn;
|
||||
}
|
||||
|
||||
foreach (var client in m_ClientNetworkManagers)
|
||||
{
|
||||
client.OnFetchLocalPlayerPrefabToSpawn = FetchLocalPlayerPrefabToSpawn;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
m_ServerNetworkManager.NetworkConfig.ConnectionApproval = true;
|
||||
m_ServerNetworkManager.ConnectionApprovalCallback += ConnectionApprovalHandler;
|
||||
foreach (var client in m_ClientNetworkManagers)
|
||||
{
|
||||
client.NetworkConfig.ConnectionApproval = true;
|
||||
}
|
||||
}
|
||||
|
||||
base.OnServerAndClientsCreated();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates the transform positions of two NetworkObject instances
|
||||
/// </summary>
|
||||
/// <param name="current">the local instance (source of truth)</param>
|
||||
/// <param name="testing">the remote instance</param>
|
||||
/// <returns></returns>
|
||||
private bool ValidateTransforms(NetworkObject current, NetworkObject testing)
|
||||
{
|
||||
if (current.ChildNetworkBehaviours.Count == 0 || testing.ChildNetworkBehaviours.Count == 0)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
for (int i = 0; i < current.NetworkTransforms.Count - 1; i++)
|
||||
{
|
||||
var transformA = current.NetworkTransforms[i].transform;
|
||||
var transformB = testing.NetworkTransforms[i].transform;
|
||||
if (!Approximately(transformA.position, transformB.position))
|
||||
{
|
||||
m_ErrorLog.AppendLine($"TransformA Position {transformA.position} != TransformB Position {transformB.position}");
|
||||
return false;
|
||||
}
|
||||
if (!Approximately(transformA.localPosition, transformB.localPosition))
|
||||
{
|
||||
m_ErrorLog.AppendLine($"TransformA Local Position {transformA.position} != TransformB Local Position {transformB.position}");
|
||||
return false;
|
||||
}
|
||||
if (transformA.parent != null)
|
||||
{
|
||||
if (current.NetworkTransforms[i].InLocalSpace != testing.NetworkTransforms[i].InLocalSpace)
|
||||
{
|
||||
m_ErrorLog.AppendLine($"NetworkTransform-{current.OwnerClientId}-{current.NetworkTransforms[i].NetworkBehaviourId} InLocalSpace ({current.NetworkTransforms[i].InLocalSpace}) is different from the remote instance version on Client-{testing.NetworkManager.LocalClientId}!");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates all player instances spawned with the correct positions including all nested NetworkTransforms
|
||||
/// When running in server authority mode we are validating this fix did not impact that.
|
||||
/// </summary>
|
||||
private bool AllClientInstancesSynchronized()
|
||||
{
|
||||
m_ErrorLog.Clear();
|
||||
|
||||
foreach (var current in m_NetworkManagers)
|
||||
{
|
||||
var currentPlayer = current.LocalClient.PlayerObject;
|
||||
var currentNetworkObjectId = currentPlayer.NetworkObjectId;
|
||||
foreach (var testing in m_NetworkManagers)
|
||||
{
|
||||
if (currentPlayer == testing.LocalClient.PlayerObject)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!testing.SpawnManager.SpawnedObjects.ContainsKey(currentNetworkObjectId))
|
||||
{
|
||||
m_ErrorLog.AppendLine($"Failed to find Client-{currentPlayer.OwnerClientId}'s player instance on Client-{testing.LocalClientId}!");
|
||||
return false;
|
||||
}
|
||||
|
||||
var remoteInstance = testing.SpawnManager.SpawnedObjects[currentNetworkObjectId];
|
||||
if (!ValidateTransforms(currentPlayer, remoteInstance))
|
||||
{
|
||||
m_ErrorLog.AppendLine($"Failed to validate Client-{currentPlayer.OwnerClientId} against its remote instance on Client-{testing.LocalClientId}!");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates that dynamically spawning works the same.
|
||||
/// When running in server authority mode we are validating this fix did not impact that.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
private bool AllSpawnedObjectsSynchronized()
|
||||
{
|
||||
m_ErrorLog.Clear();
|
||||
|
||||
foreach (var current in m_SpawnedObjects)
|
||||
{
|
||||
var currentNetworkObject = current.GetComponent<NetworkObject>();
|
||||
var currentNetworkObjectId = currentNetworkObject.NetworkObjectId;
|
||||
foreach (var testing in m_NetworkManagers)
|
||||
{
|
||||
if (currentNetworkObject.OwnerClientId == testing.LocalClientId)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!testing.SpawnManager.SpawnedObjects.ContainsKey(currentNetworkObjectId))
|
||||
{
|
||||
m_ErrorLog.AppendLine($"Failed to find Client-{currentNetworkObject.OwnerClientId}'s player instance on Client-{testing.LocalClientId}!");
|
||||
return false;
|
||||
}
|
||||
|
||||
var remoteInstance = testing.SpawnManager.SpawnedObjects[currentNetworkObjectId];
|
||||
if (!ValidateTransforms(currentNetworkObject, remoteInstance))
|
||||
{
|
||||
m_ErrorLog.AppendLine($"Failed to validate Client-{currentNetworkObject.OwnerClientId} against its remote instance on Client-{testing.LocalClientId}!");
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Validates that spawning player and dynamically spawned prefab instances with nested NetworkTransforms
|
||||
/// synchronizes properly in both client-server and distributed authority when using owner authoritative mode.
|
||||
/// </summary>
|
||||
[UnityTest]
|
||||
public IEnumerator NestedNetworkTransformSpawnPositionTest()
|
||||
{
|
||||
if (!m_DistributedAuthority || (m_DistributedAuthority && !UseCMBService()))
|
||||
{
|
||||
m_NetworkManagers.Add(m_ServerNetworkManager);
|
||||
}
|
||||
m_NetworkManagers.AddRange(m_ClientNetworkManagers);
|
||||
|
||||
yield return WaitForConditionOrTimeOut(AllClientInstancesSynchronized);
|
||||
AssertOnTimeout($"Failed to synchronize all client instances!\n{m_ErrorLog}");
|
||||
|
||||
foreach (var networkManager in m_NetworkManagers)
|
||||
{
|
||||
// Randomize the position
|
||||
RandomizeObjectTransformPositions(m_SpawnObject);
|
||||
|
||||
// Create an instance owned by the specified networkmanager
|
||||
m_SpawnedObjects.Add(SpawnObject(m_SpawnObject, networkManager));
|
||||
}
|
||||
// Randomize the position once more just to assure we are instantiating remote instances
|
||||
// with a completely different position
|
||||
RandomizeObjectTransformPositions(m_SpawnObject);
|
||||
yield return WaitForConditionOrTimeOut(AllSpawnedObjectsSynchronized);
|
||||
AssertOnTimeout($"Failed to synchronize all spawned NetworkObject instances!\n{m_ErrorLog}");
|
||||
m_SpawnedObjects.Clear();
|
||||
m_NetworkManagers.Clear();
|
||||
}
|
||||
|
||||
protected override IEnumerator OnTearDown()
|
||||
{
|
||||
// In case there was a failure, go ahead and clear these lists out for any pending TextFixture passes
|
||||
m_SpawnedObjects.Clear();
|
||||
m_NetworkManagers.Clear();
|
||||
return base.OnTearDown();
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user