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

com.unity.netcode.gameobjects@1.8.0

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).

## [1.8.0] - 2023-12-12

### Added

- Added a new RPC attribute, which is simply `Rpc`. (#2762)
  - This is a generic attribute that can perform the functions of both Server and Client RPCs, as well as enabling client-to-client RPCs. Includes several default targets: `Server`, `NotServer`, `Owner`, `NotOwner`, `Me`, `NotMe`, `ClientsAndHost`, and `Everyone`. Runtime overrides are available for any of these targets, as well as for sending to a specific ID or groups of IDs.
  - This attribute also includes the ability to defer RPCs that are sent to the local process to the start of the next frame instead of executing them immediately, treating them as if they had gone across the network. The default behavior is to execute immediately.
  - This attribute effectively replaces `ServerRpc` and `ClientRpc`. `ServerRpc` and `ClientRpc` remain in their existing forms for backward compatibility, but `Rpc` will be the recommended and most supported option.
- Added `NetworkManager.OnConnectionEvent` as a unified connection event callback to notify clients and servers of all client connections and disconnections within the session (#2762)
- Added `NetworkManager.ServerIsHost` and `NetworkBehaviour.ServerIsHost` to allow a client to tell if it is connected to a host or to a dedicated server (#2762)
- Added `SceneEventProgress.SceneManagementNotEnabled` return status to be returned when a `NetworkSceneManager` method is invoked and scene management is not enabled. (#2735)
- Added `SceneEventProgress.ServerOnlyAction` return status to be returned when a `NetworkSceneManager` method is invoked by a client. (#2735)
- Added `NetworkObject.InstantiateAndSpawn` and `NetworkSpawnManager.InstantiateAndSpawn` methods to simplify prefab spawning by assuring that the prefab is valid and applies any override prior to instantiating the `GameObject` and spawning the `NetworkObject` instance. (#2710)

### Fixed

- Fixed issue where a client disconnected by a server-host would not receive a local notification. (#2789)
- Fixed issue where a server-host could shutdown during a relay connection but periodically the transport disconnect message sent to any connected clients could be dropped. (#2789)
- Fixed issue where a host could disconnect its local client but remain running as a server. (#2789)
- Fixed issue where `OnClientDisconnectedCallback` was not being invoked under certain conditions. (#2789)
- Fixed issue where `OnClientDisconnectedCallback` was always returning 0 as the client identifier. (#2789)
- Fixed issue where if a host or server shutdown while a client owned NetworkObjects (other than the player) it would throw an exception. (#2789)
- Fixed issue where setting values on a `NetworkVariable` or `NetworkList` within `OnNetworkDespawn` during a shutdown sequence would throw an exception. (#2789)
- Fixed issue where a teleport state could potentially be overridden by a previous unreliable delta state. (#2777)
- Fixed issue where `NetworkTransform` was using the `NetworkManager.ServerTime.Tick` as opposed to `NetworkManager.NetworkTickSystem.ServerTime.Tick` during the authoritative side's tick update where it performed a delta state check. (#2777)
- Fixed issue where a parented in-scene placed NetworkObject would be destroyed upon a client or server exiting a network session but not unloading the original scene in which the NetworkObject was placed. (#2737)
- Fixed issue where during client synchronization and scene loading, when client synchronization or the scene loading mode are set to `LoadSceneMode.Single`, a `CreateObjectMessage` could be received, processed, and the resultant spawned `NetworkObject` could be instantiated in the client's currently active scene that could, towards the end of the client synchronization or loading process, be unloaded and cause the newly created `NetworkObject` to be destroyed (and throw and exception). (#2735)
- Fixed issue where a `NetworkTransform` instance with interpolation enabled would result in wide visual motion gaps (stuttering) under above normal latency conditions and a 1-5% or higher packet are drop rate. (#2713)
- Fixed issue where  you could not have multiple source network prefab overrides targeting the same network prefab as their override. (#2710)

### Changed
- Changed the server or host shutdown so it will now perform a "soft shutdown" when `NetworkManager.Shutdown` is invoked. This will send a disconnect notification to all connected clients and the server-host will wait for all connected clients to disconnect or timeout after a 5 second period before completing the shutdown process. (#2789)
- Changed `OnClientDisconnectedCallback` will now return the assigned client identifier on the local client side if the client was approved and assigned one prior to being disconnected. (#2789)
- Changed `NetworkTransform.SetState` (and related methods) now are cumulative during a fractional tick period and sent on the next pending tick. (#2777)
- `NetworkManager.ConnectedClientsIds` is now accessible on the client side and will contain the list of all clients in the session, including the host client if the server is operating in host mode (#2762)
- Changed `NetworkSceneManager` to return a `SceneEventProgress` status and not throw exceptions for methods invoked when scene management is disabled and when a client attempts to access a `NetworkSceneManager` method by a client. (#2735)
- Changed `NetworkTransform` authoritative instance tick registration so a single `NetworkTransform` specific tick event update will update all authoritative instances to improve perofmance. (#2713)
- Changed `NetworkPrefabs.OverrideToNetworkPrefab` dictionary is no longer used/populated due to it ending up being related to a regression bug and not allowing more than one override to be assigned to a network prefab asset. (#2710)
- Changed in-scene placed `NetworkObject`s now store their source network prefab asset's `GlobalObjectIdHash` internally that is used, when scene management is disabled, by clients to spawn the correct prefab even if the `NetworkPrefab` entry has an override. This does not impact dynamically spawning the same prefab which will yield the override on both host and client. (#2710)
- Changed in-scene placed `NetworkObject`s no longer require a `NetworkPrefab` entry with `GlobalObjectIdHash` override in order for clients to properly synchronize. (#2710)
- Changed in-scene placed `NetworkObject`s now set their `IsSceneObject` value when generating their `GlobalObjectIdHash` value. (#2710)
- Changed the default `NetworkConfig.SpawnTimeout` value from 1.0s to 10.0s. (#2710)
This commit is contained in:
Unity Technologies
2023-12-12 00:00:00 +00:00
parent 514166e159
commit 07f206ff9e
99 changed files with 8667 additions and 1710 deletions
Download Patch File Download Diff File Expand all files Collapse all files

137
Runtime/Core/NetworkManager.cs
View File

@@ -1,5 +1,6 @@
using System;
using System.Collections.Generic;
using Unity.Collections;
using UnityEngine;
#if UNITY_EDITOR
using UnityEditor;
@@ -42,6 +43,8 @@ namespace Unity.Netcode
ConnectionManager.ProcessPendingApprovals();
ConnectionManager.PollAndHandleNetworkEvents();
DeferredMessageManager.ProcessTriggers(IDeferredNetworkMessageManager.TriggerType.OnNextFrame, 0);
MessageManager.ProcessIncomingMessageQueue();
MessageManager.CleanupDisconnectedClients();
}
@@ -70,13 +73,89 @@ namespace Unity.Netcode
if (m_ShuttingDown)
{
ShutdownInternal();
// Host-server will disconnect any connected clients prior to finalizing its shutdown
if (IsServer)
{
ProcessServerShutdown();
}
else
{
// Clients just disconnect immediately
ShutdownInternal();
}
}
}
break;
}
}
/// <summary>
/// Used to provide a graceful shutdown sequence
/// </summary>
internal enum ServerShutdownStates
{
None,
WaitForClientDisconnects,
InternalShutdown,
ShuttingDown,
};
internal ServerShutdownStates ServerShutdownState;
private float m_ShutdownTimeout;
/// <summary>
/// This is a "soft shutdown" where the host or server will disconnect
/// all clients, with a provided reasons, prior to invoking its final
/// internal shutdown.
/// </summary>
internal void ProcessServerShutdown()
{
var minClientCount = IsHost ? 2 : 1;
switch (ServerShutdownState)
{
case ServerShutdownStates.None:
{
if (ConnectedClients.Count >= minClientCount)
{
var hostServer = IsHost ? "host" : "server";
var disconnectReason = $"Disconnected due to {hostServer} shutting down.";
for (int i = ConnectedClientsIds.Count - 1; i >= 0; i--)
{
var clientId = ConnectedClientsIds[i];
if (clientId == ServerClientId)
{
continue;
}
ConnectionManager.DisconnectClient(clientId, disconnectReason);
}
ServerShutdownState = ServerShutdownStates.WaitForClientDisconnects;
m_ShutdownTimeout = Time.realtimeSinceStartup + 5.0f;
}
else
{
ServerShutdownState = ServerShutdownStates.InternalShutdown;
ProcessServerShutdown();
}
break;
}
case ServerShutdownStates.WaitForClientDisconnects:
{
if (ConnectedClients.Count < minClientCount || m_ShutdownTimeout < Time.realtimeSinceStartup)
{
ServerShutdownState = ServerShutdownStates.InternalShutdown;
ProcessServerShutdown();
}
break;
}
case ServerShutdownStates.InternalShutdown:
{
ServerShutdownState = ServerShutdownStates.ShuttingDown;
ShutdownInternal();
break;
}
}
}
/// <summary>
/// The client id used to represent the server
/// </summary>
@@ -104,7 +183,7 @@ namespace Unity.Netcode
/// <summary>
/// Gets a list of just the IDs of all connected clients. This is only accessible on the server.
/// </summary>
public IReadOnlyList<ulong> ConnectedClientsIds => IsServer ? ConnectionManager.ConnectedClientIds : throw new NotServerException($"{nameof(ConnectionManager.ConnectedClientIds)} should only be accessed on server.");
public IReadOnlyList<ulong> ConnectedClientsIds => ConnectionManager.ConnectedClientIds;
/// <summary>
/// Gets the local <see cref="NetworkClient"/> for this client.
@@ -122,6 +201,11 @@ namespace Unity.Netcode
/// </summary>
public bool IsServer => ConnectionManager.LocalClient.IsServer;
/// <summary>
/// Gets whether or not the current server (local or remote) is a host - i.e., also a client
/// </summary>
public bool ServerIsHost => ConnectionManager.ConnectedClientIds.Contains(ServerClientId);
/// <summary>
/// Gets Whether or not a client is running
/// </summary>
@@ -209,6 +293,8 @@ namespace Unity.Netcode
/// <summary>
/// The callback to invoke once a client connects. This callback is only ran on the server and on the local client that connects.
///
/// It is recommended to use OnConnectionEvent instead, as this will eventually be deprecated
/// </summary>
public event Action<ulong> OnClientConnectedCallback
{
@@ -218,6 +304,8 @@ namespace Unity.Netcode
/// <summary>
/// The callback to invoke when a client disconnects. This callback is only ran on the server and on the local client that disconnects.
///
/// It is recommended to use OnConnectionEvent instead, as this will eventually be deprecated
/// </summary>
public event Action<ulong> OnClientDisconnectCallback
{
@@ -225,6 +313,16 @@ namespace Unity.Netcode
remove => ConnectionManager.OnClientDisconnectCallback -= value;
}
/// <summary>
/// The callback to invoke on any connection event. See <see cref="ConnectionEvent"/> and <see cref="ConnectionEventData"/>
/// for more info.
/// </summary>
public event Action<NetworkManager, ConnectionEventData> OnConnectionEvent
{
add => ConnectionManager.OnConnectionEvent += value;
remove => ConnectionManager.OnConnectionEvent -= value;
}
/// <summary>
/// The current host name we are connected to, used to validate certificate
/// </summary>
@@ -379,6 +477,24 @@ namespace Unity.Netcode
internal IDeferredNetworkMessageManager DeferredMessageManager { get; private set; }
// This erroneously tries to simplify these method references but the docs do not pick it up correctly
// because they try to resolve it on the field rather than the class of the same name.
#pragma warning disable IDE0001
/// <summary>
/// Provides access to the various <see cref="SendTo"/> targets at runtime, as well as
/// runtime-bound targets like <see cref="Unity.Netcode.RpcTarget.Single"/>,
/// <see cref="Unity.Netcode.RpcTarget.Group(NativeArray{ulong})"/>,
/// <see cref="Unity.Netcode.RpcTarget.Group(NativeList{ulong})"/>,
/// <see cref="Unity.Netcode.RpcTarget.Group(ulong[])"/>,
/// <see cref="Unity.Netcode.RpcTarget.Group{T}(T)"/>, <see cref="Unity.Netcode.RpcTarget.Not(ulong)"/>,
/// <see cref="Unity.Netcode.RpcTarget.Not(NativeArray{ulong})"/>,
/// <see cref="Unity.Netcode.RpcTarget.Not(NativeList{ulong})"/>,
/// <see cref="Unity.Netcode.RpcTarget.Not(ulong[])"/>, and
/// <see cref="Unity.Netcode.RpcTarget.Not{T}(T)"/>
/// </summary>
#pragma warning restore IDE0001
public RpcTarget RpcTarget;
/// <summary>
/// Gets the CustomMessagingManager for this NetworkManager
/// </summary>
@@ -664,6 +780,12 @@ namespace Unity.Netcode
internal void Initialize(bool server)
{
// Make sure the ServerShutdownState is reset when initializing
if (server)
{
ServerShutdownState = ServerShutdownStates.None;
}
// Don't allow the user to start a network session if the NetworkManager is
// still parented under another GameObject
if (NetworkManagerCheckForParent(true))
@@ -729,6 +851,8 @@ namespace Unity.Netcode
DeferredMessageManager = ComponentFactory.Create<IDeferredNetworkMessageManager>(this);
RpcTarget = new RpcTarget(this);
CustomMessagingManager = new CustomMessagingManager(this);
SceneManager = new NetworkSceneManager(this);
@@ -929,6 +1053,7 @@ namespace Unity.Netcode
{
LocalClientId = ServerClientId;
NetworkMetrics.SetConnectionId(LocalClientId);
MessageManager.SetLocalClientId(LocalClientId);
if (NetworkConfig.ConnectionApproval && ConnectionApprovalCallback != null)
{
@@ -1007,11 +1132,6 @@ namespace Unity.Netcode
MessageManager.StopProcessing = discardMessageQueue;
}
}
if (NetworkConfig != null && NetworkConfig.NetworkTransport != null)
{
NetworkConfig.NetworkTransport.OnTransportEvent -= ConnectionManager.HandleNetworkEvent;
}
}
// Ensures that the NetworkManager is cleaned up before OnDestroy is run on NetworkObjects and NetworkBehaviours when unloading a scene with a NetworkManager
@@ -1036,6 +1156,9 @@ namespace Unity.Netcode
DeferredMessageManager?.CleanupAllTriggers();
CustomMessagingManager = null;
RpcTarget?.Dispose();
RpcTarget = null;
BehaviourUpdater?.Shutdown();
BehaviourUpdater = null;