InnoLab/com.unity.netcode.gameobjects
Archived
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

com.unity.netcode.gameobjects@2.0.0-exp.2

Browse Source 
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.0.0-exp.2] - 2024-04-02

### Added
- Added updates to all internal messages to account for a distributed authority network session connection.  (#2863)
- Added `NetworkRigidbodyBase` that provides users with a more customizable network rigidbody, handles both `Rigidbody` and `Rigidbody2D`, and provides an option to make `NetworkTransform` use the rigid body for motion.  (#2863)
  - For a customized `NetworkRigidbodyBase` class:
    - `NetworkRigidbodyBase.AutoUpdateKinematicState` provides control on whether the kinematic setting will be automatically set or not when ownership changes.
    - `NetworkRigidbodyBase.AutoSetKinematicOnDespawn` provides control on whether isKinematic will automatically be set to true when the associated `NetworkObject` is despawned.
    - `NetworkRigidbodyBase.Initialize` is a protected method that, when invoked, will initialize the instance. This includes options to:
      - Set whether using a `RigidbodyTypes.Rigidbody` or `RigidbodyTypes.Rigidbody2D`.
      - Includes additional optional parameters to set the `NetworkTransform`, `Rigidbody`, and `Rigidbody2d` to use.
  - Provides additional public methods:
    - `NetworkRigidbodyBase.GetPosition` to return the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.GetRotation` to return the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.MovePosition` to move to the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.MoveRotation` to move to the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.Move` to move to the position and rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.Move` to move to the position and rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.SetPosition` to set the position of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.SetRotation` to set the rotation of the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting).
    - `NetworkRigidbodyBase.ApplyCurrentTransform` to set the position and rotation of the `Rigidbody` or `Rigidbody2d` based on the associated `GameObject` transform (depending upon its initialized setting).
    - `NetworkRigidbodyBase.WakeIfSleeping` to wake up the rigid body if sleeping.
    - `NetworkRigidbodyBase.SleepRigidbody` to put the rigid body to sleep.
    - `NetworkRigidbodyBase.IsKinematic` to determine if the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) is currently kinematic.
    - `NetworkRigidbodyBase.SetIsKinematic` to set the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) current kinematic state.
    - `NetworkRigidbodyBase.ResetInterpolation` to reset the `Rigidbody` or `Rigidbody2d` (depending upon its initialized setting) back to its original interpolation value when initialized.
  - Now includes a `MonoBehaviour.FixedUpdate` implementation that will update the assigned `NetworkTransform` when `NetworkRigidbodyBase.UseRigidBodyForMotion` is true. (#2863)
- Added `RigidbodyContactEventManager` that provides a more optimized way to process collision enter and collision stay events as opposed to the `Monobehaviour` approach. (#2863)
  - Can be used in client-server and distributed authority modes, but is particularly useful in distributed authority.
- Added rigid body motion updates to `NetworkTransform` which allows users to set interolation on rigid bodies. (#2863)
  - Extrapolation is only allowed on authoritative instances, but custom class derived from `NetworkRigidbodyBase` or `NetworkRigidbody` or `NetworkRigidbody2D` automatically switches non-authoritative instances to interpolation if set to extrapolation.
- Added distributed authority mode support to `NetworkAnimator`. (#2863)
- Added session mode selection to `NetworkManager` inspector view. (#2863)
- Added distributed authority permissions feature. (#2863)
- Added distributed authority mode specific `NetworkObject` permissions flags (Distributable, Transferable, and RequestRequired). (#2863)
- Added distributed authority mode specific `NetworkObject.SetOwnershipStatus` method that applies one or more `NetworkObject` instance's ownership flags. If updated when spawned, the ownership permission changes are synchronized with the other connected clients. (#2863)
- Added distributed authority mode specific `NetworkObject.RemoveOwnershipStatus` method that removes one or more `NetworkObject` instance's ownership flags. If updated when spawned, the ownership permission changes are synchronized with the other connected clients. (#2863)
- Added distributed authority mode specific `NetworkObject.HasOwnershipStatus` method that will return (true or false) whether one or more ownership flags is set. (#2863)
- Added distributed authority mode specific `NetworkObject.SetOwnershipLock` method that locks ownership of a `NetworkObject` to prevent ownership from changing until the current owner releases the lock. (#2863)
- Added distributed authority mode specific `NetworkObject.RequestOwnership` method that sends an ownership request to the current owner of a spawned `NetworkObject` instance. (#2863)
- Added distributed authority mode specific `NetworkObject.OnOwnershipRequested` callback handler that is invoked on the owner/authoritative side when a non-owner requests ownership. Depending upon the boolean returned value depends upon whether the request is approved or denied. (#2863)
- Added distributed authority mode specific `NetworkObject.OnOwnershipRequestResponse` callback handler that is invoked when a non-owner's request has been processed. This callback includes a `NetworkObjet.OwnershipRequestResponseStatus` response parameter that describes whether the request was approved or the reason why it was not approved. (#2863)
- Added distributed authority mode specific `NetworkObject.DeferDespawn` method that defers the despawning of `NetworkObject` instances on non-authoritative clients based on the tick offset parameter. (#2863)
- Added distributed authority mode specific `NetworkObject.OnDeferredDespawnComplete` callback handler that can be used to further control when deferring the despawning of a `NetworkObject` on non-authoritative instances. (#2863)
- Added `NetworkClient.SessionModeType` as one way to determine the current session mode of the network session a client is connected to. (#2863)
- Added distributed authority mode specific `NetworkClient.IsSessionOwner` property to determine if the current local client is the current session owner of a distributed authority session. (#2863)
- Added distributed authority mode specific client side spawning capabilities. When running in distributed authority mode, clients can instantiate and spawn `NetworkObject` instances (the local client is authomatically the owner of the spawned object). (#2863)
  - This is useful to better visually synchronize owner authoritative motion models and newly spawned `NetworkObject` instances (i.e. projectiles for example).
- Added distributed authority mode specific client side player spawning capabilities. Clients will automatically spawn their associated player object locally. (#2863)
- Added distributed authority mode specific `NetworkConfig.AutoSpawnPlayerPrefabClientSide` property (default is true) to provide control over the automatic spawning of player prefabs on the local client side. (#2863)
- Added distributed authority mode specific `NetworkManager.OnFetchLocalPlayerPrefabToSpawn` callback that, when assigned, will allow the local client to provide the player prefab to be spawned for the local client. (#2863)
  - This is only invoked if the `NetworkConfig.AutoSpawnPlayerPrefabClientSide` property is set to true.
- Added distributed authority mode specific `NetworkBehaviour.HasAuthority` property that determines if the local client has authority over the associated `NetworkObject` instance (typical use case is within a `NetworkBehaviour` script much like that of `IsServer` or `IsClient`). (#2863)
- Added distributed authority mode specific `NetworkBehaviour.IsSessionOwner` property that determines if the local client is the session owner (typical use case would be to determine if the local client can has scene management authority within a `NetworkBehaviour` script). (#2863)
- Added support for distributed authority mode scene management where the currently assigned session owner can start scene events (i.e. scene loading and scene unloading). (#2863)

### Fixed

- Fixed issue where the host was not invoking `OnClientDisconnectCallback` for its own local client when internally shutting down. (#2822)
- Fixed issue where NetworkTransform could potentially attempt to "unregister" a named message prior to it being registered. (#2807)
- Fixed issue where in-scene placed `NetworkObject`s with complex nested children `NetworkObject`s (more than one child in depth) would not synchronize properly if WorldPositionStays was set to true. (#2796)

### Changed
- Changed client side awareness of other clients is now the same as a server or host. (#2863)
- Changed `NetworkManager.ConnectedClients` can now be accessed by both server and clients. (#2863)
- Changed `NetworkManager.ConnectedClientsList` can now be accessed by both server and clients. (#2863)
- Changed `NetworkTransform` defaults to owner authoritative when connected to a distributed authority session. (#2863)
- Changed `NetworkVariable` defaults to owner write and everyone read permissions when connected to a distributed authority session (even if declared with server read or write permissions).  (#2863)
- Changed `NetworkObject` no longer implements the `MonoBehaviour.Update` method in order to determine whether a `NetworkObject` instance has been migrated to a different scene. Instead, only `NetworkObjects` with the `SceneMigrationSynchronization` property set will be updated internally during the `NetworkUpdateStage.PostLateUpdate` by `NetworkManager`. (#2863)
- Changed `NetworkManager` inspector view layout where properties are now organized by category. (#2863)
- Changed `NetworkTransform` to now use `NetworkTransformMessage` as opposed to named messages for NetworkTransformState updates. (#2810)
- Changed `CustomMessageManager` so it no longer attempts to register or "unregister" a null or empty string and will log an error if this condition occurs. (#2807)
This commit is contained in:
Unity Technologies
2024-04-02 00:00:00 +00:00
parent f8ebf679ec
commit 143a6cbd34
140 changed files with 18009 additions and 2672 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
Runtime/Connection/NetworkClient.cs
View File

@@ -1,7 +1,15 @@
using System.Collections.Generic;
using UnityEngine;
namespace Unity.Netcode
{
public enum SessionModeTypes
{
ClientServer,
DistributedAuthority
}
/// <summary>
/// A NetworkClient
/// </summary>
@@ -33,6 +41,15 @@ namespace Unity.Netcode
/// </summary>
internal bool IsApproved { get; set; }
public SessionModeTypes SessionModeType { get; internal set; }
public bool DAHost { get; internal set; }
/// <summary>
/// Is true when the client has been assigned session ownership in distributed authority mode
/// </summary>
public bool IsSessionOwner { get; internal set; }
/// <summary>
/// The ClientId of the NetworkClient
/// </summary>
@@ -50,21 +67,54 @@ namespace Unity.Netcode
internal NetworkSpawnManager SpawnManager { get; private set; }
internal void SetRole(bool isServer, bool isClient, NetworkManager networkManager = null)
internal bool SetRole(bool isServer, bool isClient, NetworkManager networkManager = null)
{
ResetClient(isServer, isClient);
IsServer = isServer;
IsClient = isClient;
if (!IsServer && !isClient)
if (networkManager != null)
{
SpawnManager = networkManager.SpawnManager;
SessionModeType = networkManager.NetworkConfig.SessionMode;
if (SessionModeType == SessionModeTypes.DistributedAuthority)
{
DAHost = IsClient && IsServer;
// DANGO-TODO: We might allow a dedicated mock CMB server, but for now do not allow this
if (!IsClient && IsServer)
{
Debug.LogError("You cannot start NetworkManager as a server when operating in distributed authority mode!");
return false;
}
if (DAHost && networkManager.CMBServiceConnection)
{
Debug.LogError("You cannot start a host when connecting to a distributed authority CMB Service!");
return false;
}
}
}
return true;
}
/// <summary>
/// Only to be invoked when setting the role.
/// This resets the current NetworkClient's properties.
/// </summary>
private void ResetClient(bool isServer, bool isClient)
{
// If we are niether client nor server, then reset properties (i.e. client has no role)
if (!IsServer && !IsClient)
{
PlayerObject = null;
ClientId = 0;
IsConnected = false;
IsApproved = false;
}
if (networkManager != null)
{
SpawnManager = networkManager.SpawnManager;
SpawnManager = null;
DAHost = false;
}
}

318
Runtime/Connection/NetworkConnectionManager.cs
View File

@@ -1,12 +1,12 @@
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.CompilerServices;
using Unity.Collections;
using Unity.Collections.LowLevel.Unsafe;
using Unity.Profiling;
using UnityEngine;
using Object = UnityEngine.Object;
namespace Unity.Netcode
{
@@ -366,6 +366,10 @@ namespace Unity.Netcode
{
networkEvent = NetworkManager.NetworkConfig.NetworkTransport.PollEvent(out ulong transportClientId, out ArraySegment<byte> payload, out float receiveTime);
HandleNetworkEvent(networkEvent, transportClientId, payload, receiveTime);
if (networkEvent == NetworkEvent.Disconnect || networkEvent == NetworkEvent.TransportFailure)
{
break;
}
// Only do another iteration if: there are no more messages AND (there is no limit to max events or we have processed less than the maximum)
} while (NetworkManager.IsListening && networkEvent != NetworkEvent.Nothing);
@@ -430,16 +434,17 @@ namespace Unity.Netcode
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
{
NetworkLog.LogInfo("Client Connected");
var hostServer = NetworkManager.IsHost ? "Host" : "Server";
NetworkLog.LogInfo($"[{hostServer}-Side] Transport connection established with pending Client-{clientId}.");
}
AddPendingClient(clientId);
}
else
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
{
NetworkLog.LogInfo("Connected");
var serverOrService = NetworkManager.DistributedAuthorityMode ? NetworkManager.CMBServiceConnection ? "service" : "DAHost" : "server";
NetworkLog.LogInfo($"[Approval Pending][Client] Transport connection with {serverOrService} established! Awaiting connection approval...");
}
SendConnectionRequest();
@@ -546,6 +551,10 @@ namespace Unity.Netcode
{
var message = new ConnectionRequestMessage
{
CMBServiceConnection = NetworkManager.CMBServiceConnection,
TickRate = NetworkManager.NetworkConfig.TickRate,
EnableSceneManagement = NetworkManager.NetworkConfig.EnableSceneManagement,
// Since only a remote client will send a connection request, we should always force the rebuilding of the NetworkConfig hash value
ConfigHash = NetworkManager.NetworkConfig.GetConfig(false),
ShouldSendConnectionData = NetworkManager.NetworkConfig.ConnectionApproval,
@@ -701,6 +710,12 @@ namespace Unity.Netcode
}
}
/// <summary>
/// Adding this because message hooks cannot happen fast enough under certain scenarios
/// where the message is sent and responded to before the hook is in place.
/// </summary>
internal bool MockSkippingApproval;
/// <summary>
/// Server Side: Handles the approval of a client
/// </summary>
@@ -712,12 +727,15 @@ namespace Unity.Netcode
LocalClient.IsApproved = response.Approved;
if (response.Approved)
{
if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
{
NetworkLog.LogInfo($"[Server-Side] Pending Client-{ownerClientId} connection approved!");
}
// The client was approved, stop the server-side approval time out coroutine
RemovePendingClient(ownerClientId);
var client = AddClient(ownerClientId);
if (response.CreatePlayerObject)
if (!NetworkManager.DistributedAuthorityMode && response.CreatePlayerObject && NetworkManager.NetworkConfig.PlayerPrefab != null)
{
var prefabNetworkObject = NetworkManager.NetworkConfig.PlayerPrefab.GetComponent<NetworkObject>();
var playerPrefabHash = response.PlayerPrefabHash ?? prefabNetworkObject.GlobalObjectIdHash;
@@ -732,6 +750,7 @@ namespace Unity.Netcode
HasTransform = prefabNetworkObject.SynchronizeTransform,
Hash = playerPrefabHash,
TargetClientId = ownerClientId,
DontDestroyWithOwner = prefabNetworkObject.DontDestroyWithOwner,
Transform = new NetworkObject.SceneObject.TransformData
{
Position = response.Position.GetValueOrDefault(),
@@ -761,6 +780,7 @@ namespace Unity.Netcode
{
OwnerClientId = ownerClientId,
NetworkTick = NetworkManager.LocalTime.Tick,
IsDistributedAuthority = NetworkManager.DistributedAuthorityMode,
ConnectedClientIds = new NativeArray<ulong>(ConnectedClientIds.Count, Allocator.Temp)
};
@@ -794,10 +814,20 @@ namespace Unity.Netcode
};
}
}
SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ownerClientId);
if (!MockSkippingApproval)
{
SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ownerClientId);
}
else
{
NetworkLog.LogInfo("Mocking server not responding with connection approved...");
}
message.MessageVersions.Dispose();
message.ConnectedClientIds.Dispose();
if (MockSkippingApproval)
{
return;
}
// If scene management is disabled, then we are done and notify the local host-server the client is connected
if (!NetworkManager.NetworkConfig.EnableSceneManagement)
@@ -808,10 +838,19 @@ namespace Unity.Netcode
{
InvokeOnPeerConnectedCallback(ownerClientId);
}
NetworkManager.SpawnManager.DistributeNetworkObjects(ownerClientId);
}
else // Otherwise, let NetworkSceneManager handle the initial scene and NetworkObject synchronization
{
NetworkManager.SceneManager.SynchronizeNetworkObjects(ownerClientId);
if (NetworkManager.DistributedAuthorityMode && NetworkManager.LocalClient.IsSessionOwner)
{
NetworkManager.SceneManager.SynchronizeNetworkObjects(ownerClientId);
}
else if (!NetworkManager.DistributedAuthorityMode)
{
NetworkManager.SceneManager.SynchronizeNetworkObjects(ownerClientId);
}
}
}
else // Server just adds itself as an observer to all spawned NetworkObjects
@@ -819,6 +858,17 @@ namespace Unity.Netcode
LocalClient = client;
NetworkManager.SpawnManager.UpdateObservedNetworkObjects(ownerClientId);
LocalClient.IsConnected = true;
// If running mock service, then set the instance as the default session owner
if (NetworkManager.DistributedAuthorityMode && NetworkManager.DAHost)
{
NetworkManager.SetSessionOwner(NetworkManager.LocalClientId);
NetworkManager.SceneManager.InitializeScenesLoaded();
}
if (NetworkManager.DistributedAuthorityMode && NetworkManager.AutoSpawnPlayerPrefabClientSide)
{
CreateAndSpawnPlayer(ownerClientId);
}
}
if (!response.CreatePlayerObject || (response.PlayerPrefabHash == null && NetworkManager.NetworkConfig.PlayerPrefab == null))
@@ -826,6 +876,11 @@ namespace Unity.Netcode
return;
}
// Players are always spawned by their respective client, exit early. (DAHost mode anyway, CMB Service will never spawn player prefab)
if (NetworkManager.DistributedAuthorityMode)
{
return;
}
// Separating this into a contained function call for potential further future separation of when this notification is sent.
ApprovedPlayerSpawn(ownerClientId, response.PlayerPrefabHash ?? NetworkManager.NetworkConfig.PlayerPrefab.GetComponent<NetworkObject>().GlobalObjectIdHash);
}
@@ -840,11 +895,28 @@ namespace Unity.Netcode
SendMessage(ref disconnectReason, NetworkDelivery.Reliable, ownerClientId);
MessageManager.ProcessSendQueues();
}
DisconnectRemoteClient(ownerClientId);
}
}
/// <summary>
/// Client-Side Spawning in distributed authority mode uses this to spawn the player.
/// </summary>
internal void CreateAndSpawnPlayer(ulong ownerId, Vector3 position = default, Quaternion rotation = default)
{
if (NetworkManager.DistributedAuthorityMode && NetworkManager.AutoSpawnPlayerPrefabClientSide)
{
var playerPrefab = NetworkManager.FetchLocalPlayerPrefabToSpawn();
if (playerPrefab != null)
{
var globalObjectIdHash = playerPrefab.GetComponent<NetworkObject>().GlobalObjectIdHash;
var networkObject = NetworkManager.SpawnManager.GetNetworkObjectToSpawn(globalObjectIdHash, ownerId, position, rotation);
networkObject.IsSceneObject = false;
networkObject.SpawnAsPlayerObject(ownerId, networkObject.DestroyWithScene);
}
}
}
/// <summary>
/// Spawns the newly approved player
/// </summary>
@@ -864,8 +936,10 @@ namespace Unity.Netcode
var message = new CreateObjectMessage
{
ObjectInfo = ConnectedClients[clientId].PlayerObject.GetMessageSceneObject(clientPair.Key)
ObjectInfo = ConnectedClients[clientId].PlayerObject.GetMessageSceneObject(clientPair.Key),
IncludesSerializedObject = true,
};
message.ObjectInfo.Hash = playerPrefabHash;
message.ObjectInfo.IsSceneObject = false;
message.ObjectInfo.HasParent = false;
@@ -883,20 +957,92 @@ namespace Unity.Netcode
/// </summary>
internal NetworkClient AddClient(ulong clientId)
{
if (ConnectedClients.ContainsKey(clientId) && ConnectedClientIds.Contains(clientId) && ConnectedClientsList.Contains(ConnectedClients[clientId]))
{
return ConnectedClients[clientId];
}
var networkClient = LocalClient;
networkClient = new NetworkClient();
// If this is not the local client then create a new one
if (clientId != NetworkManager.LocalClientId)
{
networkClient = new NetworkClient();
}
networkClient.SetRole(clientId == NetworkManager.ServerClientId, isClient: true, NetworkManager);
networkClient.ClientId = clientId;
if (!ConnectedClients.ContainsKey(clientId))
{
ConnectedClients.Add(clientId, networkClient);
}
if (!ConnectedClientsList.Contains(networkClient))
{
ConnectedClientsList.Add(networkClient);
}
if (NetworkManager.LocalClientId != clientId)
{
if ((!NetworkManager.DistributedAuthorityMode && NetworkManager.IsServer) ||
(NetworkManager.DistributedAuthorityMode && NetworkManager.NetworkConfig.EnableSceneManagement && NetworkManager.DAHost && NetworkManager.LocalClient.IsSessionOwner))
{
var message = new ClientConnectedMessage { ClientId = clientId };
NetworkManager.MessageManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, ConnectedClientIds.Where((c) => c != NetworkManager.LocalClientId).ToArray());
}
else if (NetworkManager.DistributedAuthorityMode && NetworkManager.NetworkConfig.EnableSceneManagement && NetworkManager.DAHost && !NetworkManager.LocalClient.IsSessionOwner)
{
var message = new ClientConnectedMessage
{
ShouldSynchronize = true,
ClientId = clientId
};
NetworkManager.MessageManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, NetworkManager.CurrentSessionOwner);
}
}
if (!ConnectedClientIds.Contains(clientId))
{
ConnectedClientIds.Add(clientId);
}
foreach (var networkObject in NetworkManager.SpawnManager.SpawnedObjectsList)
{
if (networkObject.SpawnWithObservers)
{
networkObject.Observers.Add(clientId);
}
}
ConnectedClients.Add(clientId, networkClient);
ConnectedClientsList.Add(networkClient);
var message = new ClientConnectedMessage { ClientId = clientId };
NetworkManager.MessageManager.SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ConnectedClientIds);
ConnectedClientIds.Add(clientId);
return networkClient;
}
/// <summary>
/// Invoked on clients when another client disconnects
/// </summary>
/// <param name="clientId">the client identifier to remove</param>
internal void RemoveClient(ulong clientId)
{
if (ConnectedClientIds.Contains(clientId))
{
ConnectedClientIds.Remove(clientId);
}
if (ConnectedClients.ContainsKey(clientId))
{
ConnectedClientsList.Remove(ConnectedClients[clientId]);
}
ConnectedClients.Remove(clientId);
foreach (var networkObject in NetworkManager.SpawnManager.SpawnedObjectsList)
{
networkObject.Observers.Remove(clientId);
}
}
/// <summary>
/// DANGO-TODO: Until we have the CMB Server end-to-end with all features verified working via integration tests,
/// I am keeping this debug toggle available. (NSS)
/// </summary>
internal bool EnableDistributeLogging;
/// <summary>
/// Server-Side:
/// Invoked when a client is disconnected from a server-host
@@ -923,25 +1069,55 @@ namespace Unity.Netcode
{
if (!playerObject.DontDestroyWithOwner)
{
if (NetworkManager.PrefabHandler.ContainsHandler(ConnectedClients[clientId].PlayerObject.GlobalObjectIdHash))
// DANGO-TODO: This is something that would be best for CMB Service to handle as it is part of the disconnection process
// If a player NetworkObject is being despawned, make sure to remove all children if they are marked to not be destroyed
// with the owner.
if (NetworkManager.DistributedAuthorityMode && NetworkManager.DAHost)
{
NetworkManager.PrefabHandler.HandleNetworkPrefabDestroy(ConnectedClients[clientId].PlayerObject);
// Remove any children from the player object if they are not going to be destroyed with the owner
var childNetworkObjects = playerObject.GetComponentsInChildren<NetworkObject>();
foreach (var child in childNetworkObjects)
{
// TODO: We have always just removed all children, but we might think about changing this to preserve the nested child
// hierarchy.
if (child.DontDestroyWithOwner && child.transform.transform.parent != null)
{
// If we are here, then we are running in DAHost mode and have the authority to remove the child from its parent
child.AuthorityAppliedParenting = true;
child.TryRemoveParentCachedWorldPositionStays();
}
}
}
if (NetworkManager.PrefabHandler.ContainsHandler(playerObject.GlobalObjectIdHash))
{
if (NetworkManager.DAHost && NetworkManager.DistributedAuthorityMode)
{
NetworkManager.SpawnManager.DespawnObject(playerObject, true, NetworkManager.DistributedAuthorityMode);
}
else
{
NetworkManager.PrefabHandler.HandleNetworkPrefabDestroy(playerObject);
}
}
else if (playerObject.IsSpawned)
{
// Call despawn to assure NetworkBehaviour.OnNetworkDespawn is invoked on the server-side (when the client side disconnected).
// This prevents the issue (when just destroying the GameObject) where any NetworkBehaviour component(s) destroyed before the NetworkObject would not have OnNetworkDespawn invoked.
NetworkManager.SpawnManager.DespawnObject(playerObject, true);
NetworkManager.SpawnManager.DespawnObject(playerObject, true, NetworkManager.DistributedAuthorityMode);
}
}
else if (!NetworkManager.ShutdownInProgress)
{
playerObject.RemoveOwnership();
if (!NetworkManager.ShutdownInProgress)
{
playerObject.RemoveOwnership();
}
}
}
// Get the NetworkObjects owned by the disconnected client
var clientOwnedObjects = NetworkManager.SpawnManager.GetClientOwnedObjects(clientId);
var clientOwnedObjects = NetworkManager.SpawnManager.SpawnedObjectsList.Where((c) => c.OwnerClientId == clientId).ToList();
if (clientOwnedObjects == null)
{
// This could happen if a client is never assigned a player object and is disconnected
@@ -954,6 +1130,9 @@ namespace Unity.Netcode
else
{
// Handle changing ownership and prefab handlers
var clientCounter = 0;
var predictedClientCount = ConnectedClientsList.Count - 1;
var remainingClients = NetworkManager.DistributedAuthorityMode ? ConnectedClientsList.Where((c) => c.ClientId != clientId).ToList() : null;
for (int i = clientOwnedObjects.Count - 1; i >= 0; i--)
{
var ownedObject = clientOwnedObjects[i];
@@ -963,16 +1142,72 @@ namespace Unity.Netcode
{
if (NetworkManager.PrefabHandler.ContainsHandler(clientOwnedObjects[i].GlobalObjectIdHash))
{
NetworkManager.SpawnManager.DespawnObject(ownedObject, true, true);
NetworkManager.PrefabHandler.HandleNetworkPrefabDestroy(clientOwnedObjects[i]);
}
else
{
Object.Destroy(ownedObject.gameObject);
NetworkManager.SpawnManager.DespawnObject(ownedObject, true, true);
}
}
else if (!NetworkManager.ShutdownInProgress)
{
ownedObject.RemoveOwnership();
// NOTE: All of the below code only handles ownership transfer.
// For client-server, we just remove the ownership.
// For distributed authority, we need to change ownership based on parenting
if (NetworkManager.DistributedAuthorityMode)
{
// Only NetworkObjects that have the OwnershipStatus.Distributable flag set and no parent
// (ownership is transferred to all children) will have their ownership redistributed.
if (ownedObject.IsOwnershipDistributable && ownedObject.GetCachedParent() == null)
{
if (ownedObject.IsOwnershipLocked)
{
ownedObject.SetOwnershipLock(false);
}
// DANGO-TODO: We will want to match how the CMB service handles this. For now, we just try to evenly distribute
// ownership.
var targetOwner = NetworkManager.ServerClientId;
if (predictedClientCount > 1)
{
clientCounter++;
clientCounter = clientCounter % predictedClientCount;
targetOwner = remainingClients[clientCounter].ClientId;
}
if (EnableDistributeLogging)
{
Debug.Log($"[Disconnected][Client-{clientId}][NetworkObjectId-{ownedObject.NetworkObjectId} Distributed to Client-{targetOwner}");
}
NetworkManager.SpawnManager.ChangeOwnership(ownedObject, targetOwner, true);
// DANGO-TODO: Should we try handling inactive NetworkObjects?
// Ownership gets passed down to all children
var childNetworkObjects = ownedObject.GetComponentsInChildren<NetworkObject>();
foreach (var childObject in childNetworkObjects)
{
// We already changed ownership for this
if (childObject == ownedObject)
{
continue;
}
// If the client owner disconnected, it is ok to unlock this at this point in time.
if (childObject.IsOwnershipLocked)
{
childObject.SetOwnershipLock(false);
}
NetworkManager.SpawnManager.ChangeOwnership(childObject, targetOwner, true);
if (EnableDistributeLogging)
{
Debug.Log($"[Disconnected][Client-{clientId}][Child of {ownedObject.NetworkObjectId}][NetworkObjectId-{ownedObject.NetworkObjectId} Distributed to Client-{targetOwner}");
}
}
}
}
else
{
ownedObject.RemoveOwnership();
}
}
}
}
@@ -993,6 +1228,37 @@ namespace Unity.Netcode
ConnectedClientIds.Remove(clientId);
var message = new ClientDisconnectedMessage { ClientId = clientId };
MessageManager?.SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, ConnectedClientIds);
if (NetworkManager.DistributedAuthorityMode && !NetworkManager.ShutdownInProgress && NetworkManager.IsListening)
{
var newSessionOwner = NetworkManager.LocalClientId;
if (ConnectedClientIds.Count > 1)
{
var lowestRTT = ulong.MaxValue;
var unityTransport = NetworkManager.NetworkConfig.NetworkTransport as Transports.UTP.UnityTransport;
foreach (var identifier in ConnectedClientIds)
{
if (identifier == NetworkManager.LocalClientId)
{
continue;
}
var rtt = unityTransport.GetCurrentRtt(identifier);
if (rtt < lowestRTT)
{
newSessionOwner = identifier;
lowestRTT = rtt;
}
}
}
var sessionOwnerMessage = new SessionOwnerMessage()
{
SessionOwner = newSessionOwner,
};
MessageManager?.SendMessage(ref sessionOwnerMessage, NetworkDelivery.ReliableFragmentedSequenced, ConnectedClientIds);
NetworkManager.SetSessionOwner(newSessionOwner);
}
}
// If the client ID transport map exists
@@ -1259,8 +1525,8 @@ namespace Unity.Netcode
internal int SendMessage<T>(ref T message, NetworkDelivery delivery, ulong clientId)
where T : INetworkMessage
{
// Prevent server sending to itself
if (LocalClient.IsServer && clientId == NetworkManager.ServerClientId)
// Prevent server sending to itself or if there is no MessageManager yet then exit early
if ((LocalClient.IsServer && clientId == NetworkManager.ServerClientId) || MessageManager == null)
{
return 0;
}