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.2.0] - 2024-12-12 ### Added - Added `NetworkObject.OwnershipStatus.SessionOwner` to allow Network Objects to be distributable and only owned by the Session Owner. This flag will override all other `OwnershipStatus` flags. (#3175) - Added `UnityTransport.GetEndpoint` method to provide a way to obtain `NetworkEndpoint` information of a connection via client identifier. (#3130) - Added `NetworkTransport.OnEarlyUpdate` and `NetworkTransport.OnPostLateUpdate` methods to provide more control over handling transport related events at the start and end of each frame. (#3113) ### Fixed - Fixed issue where the server, host, or session owner would not populate the in-scene place `NetworkObject` table if the scene was loaded prior to starting the `NetworkManager`. (#3177) - Fixed issue where the `NetworkObjectIdHash` value could be incorrect when entering play mode while still in prefab edit mode with pending changes and using MPPM. (#3162) - Fixed issue where a sever only `NetworkManager` instance would spawn the actual `NetworkPrefab`'s `GameObject` as opposed to creating an instance of it. (#3160) - Fixed issue where only the session owner (as opposed to all clients) would handle spawning prefab overrides properly when using a distributed authority network topology. (#3160) - Fixed issue where an exception was thrown when calling `NetworkManager.Shutdown` after calling `UnityTransport.Shutdown`. (#3118) - Fixed issue where `NetworkList` properties on in-scene placed `NetworkObject`s could cause small memory leaks when entering playmode. (#3147) - Fixed in-scene `NertworkObject` synchronization issue when loading a scene with currently connected clients connected to a session created by a `NetworkManager` started as a server (i.e. not as a host). (#3133) - Fixed issue where a `NetworkManager` started as a server would not add itself as an observer to in-scene placed `NetworkObject`s instantiated and spawned by a scene loading event. (#3133) - Fixed issue where spawning a player using `NetworkObject.InstantiateAndSpawn` or `NetworkSpawnManager.InstantiateAndSpawn` would not update the `NetworkSpawnManager.PlayerObjects` or assign the newly spawned player to the `NetworkClient.PlayerObject`. (#3122) - Fixed issue where queued UnitTransport (NetworkTransport) message batches were being sent on the next frame. They are now sent at the end of the frame during `PostLateUpdate`. (#3113) - Fixed issue where `NotOwnerRpcTarget` or `OwnerRpcTarget` were not using their replacements `NotAuthorityRpcTarget` and `AuthorityRpcTarget` which would invoke a warning. (#3111) - Fixed issue where client is removed as an observer from spawned objects when their player instance is despawned. (#3110) - Fixed issue where `NetworkAnimator` would statically allocate write buffer space for `Animator` parameters that could cause a write error if the number of parameters exceeded the space allocated. (#3108) ### Changed - In-scene placed `NetworkObject`s have been made distributable when balancing object distribution after a connection event. (#3175) - Optimised `NetworkVariable` and `NetworkTransform` related packets when in Distributed Authority mode. - The Debug Simulator section of the Unity Transport component was removed. This section was not functional anymore and users are now recommended to use the more featureful [Network Simulator](https://docs-multiplayer.unity3d.com/tools/current/tools-network-simulator/) tool from the Multiplayer Tools package instead. (#3121)
223 lines
9.0 KiB
C#
223 lines
9.0 KiB
C#
using Unity.Collections;
|
|
|
|
namespace Unity.Netcode
|
|
{
|
|
/// <summary>
|
|
/// Only used when connecting to the distributed authority service
|
|
/// </summary>
|
|
internal struct ClientConfig : INetworkSerializable
|
|
{
|
|
public SessionConfig SessionConfig;
|
|
public int SessionVersion => (int)SessionConfig.SessionVersion;
|
|
public uint TickRate;
|
|
public bool EnableSceneManagement;
|
|
|
|
// Only gets deserialized but should never be used unless testing
|
|
public int RemoteClientSessionVersion;
|
|
|
|
public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
|
|
{
|
|
// Clients always write
|
|
if (serializer.IsWriter)
|
|
{
|
|
var writer = serializer.GetFastBufferWriter();
|
|
BytePacker.WriteValueBitPacked(writer, SessionVersion);
|
|
BytePacker.WriteValueBitPacked(writer, TickRate);
|
|
writer.WriteValueSafe(EnableSceneManagement);
|
|
}
|
|
else
|
|
{
|
|
var reader = serializer.GetFastBufferReader();
|
|
ByteUnpacker.ReadValueBitPacked(reader, out RemoteClientSessionVersion);
|
|
ByteUnpacker.ReadValueBitPacked(reader, out TickRate);
|
|
reader.ReadValueSafe(out EnableSceneManagement);
|
|
}
|
|
}
|
|
}
|
|
|
|
internal struct ConnectionRequestMessage : INetworkMessage
|
|
{
|
|
internal const string InvalidSessionVersionMessage = "The client version is not compatible with the session version.";
|
|
|
|
// This version update is unidirectional (client to service) and version
|
|
// handling occurs on the service side. This serialized data is never sent
|
|
// to a host or server.
|
|
private const int k_SendClientConfigToService = 1;
|
|
public int Version => k_SendClientConfigToService;
|
|
|
|
public ulong ConfigHash;
|
|
public bool DistributedAuthority;
|
|
public ClientConfig ClientConfig;
|
|
|
|
public byte[] ConnectionData;
|
|
|
|
public bool ShouldSendConnectionData;
|
|
|
|
public NativeArray<MessageVersionData> MessageVersions;
|
|
|
|
public void Serialize(FastBufferWriter writer, int targetVersion)
|
|
{
|
|
// ============================================================
|
|
// BEGIN FORBIDDEN SEGMENT
|
|
// DO NOT CHANGE THIS HEADER. Everything added to this message
|
|
// must go AFTER the message version header.
|
|
// ============================================================
|
|
BytePacker.WriteValueBitPacked(writer, MessageVersions.Length);
|
|
foreach (var messageVersion in MessageVersions)
|
|
{
|
|
messageVersion.Serialize(writer);
|
|
}
|
|
// ============================================================
|
|
// END FORBIDDEN SEGMENT
|
|
// ============================================================
|
|
|
|
if (DistributedAuthority)
|
|
{
|
|
writer.WriteNetworkSerializable(ClientConfig);
|
|
}
|
|
|
|
if (ShouldSendConnectionData)
|
|
{
|
|
writer.WriteValueSafe(ConfigHash);
|
|
writer.WriteValueSafe(ConnectionData);
|
|
}
|
|
else
|
|
{
|
|
writer.WriteValueSafe(ConfigHash);
|
|
}
|
|
}
|
|
|
|
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
|
{
|
|
var networkManager = (NetworkManager)context.SystemOwner;
|
|
if (!networkManager.IsServer)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// ============================================================
|
|
// BEGIN FORBIDDEN SEGMENT
|
|
// DO NOT CHANGE THIS HEADER. Everything added to this message
|
|
// must go AFTER the message version header.
|
|
// ============================================================
|
|
ByteUnpacker.ReadValueBitPacked(reader, out int length);
|
|
for (var i = 0; i < length; ++i)
|
|
{
|
|
var messageVersion = new MessageVersionData();
|
|
messageVersion.Deserialize(reader);
|
|
networkManager.ConnectionManager.MessageManager.SetVersion(context.SenderId, messageVersion.Hash, messageVersion.Version);
|
|
|
|
// Update the received version since this message will always be passed version 0, due to the map not
|
|
// being initialized until just now.
|
|
var messageType = networkManager.ConnectionManager.MessageManager.GetMessageForHash(messageVersion.Hash);
|
|
if (messageType == typeof(ConnectionRequestMessage))
|
|
{
|
|
receivedMessageVersion = messageVersion.Version;
|
|
}
|
|
}
|
|
// ============================================================
|
|
// END FORBIDDEN SEGMENT
|
|
// ============================================================
|
|
|
|
if (networkManager.DAHost)
|
|
{
|
|
reader.ReadNetworkSerializable(out ClientConfig);
|
|
}
|
|
|
|
if (networkManager.NetworkConfig.ConnectionApproval)
|
|
{
|
|
if (!reader.TryBeginRead(FastBufferWriter.GetWriteSize(ConfigHash) + FastBufferWriter.GetWriteSize<int>()))
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"Incomplete connection request message given config - possible {nameof(NetworkConfig)} mismatch.");
|
|
}
|
|
|
|
networkManager.DisconnectClient(context.SenderId);
|
|
return false;
|
|
}
|
|
|
|
reader.ReadValue(out ConfigHash);
|
|
|
|
if (!networkManager.NetworkConfig.CompareConfig(ConfigHash))
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"{nameof(NetworkConfig)} mismatch. The configuration between the server and client does not match");
|
|
}
|
|
|
|
networkManager.DisconnectClient(context.SenderId);
|
|
return false;
|
|
}
|
|
|
|
reader.ReadValueSafe(out ConnectionData);
|
|
}
|
|
else
|
|
{
|
|
if (!reader.TryBeginRead(FastBufferWriter.GetWriteSize(ConfigHash)))
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"Incomplete connection request message.");
|
|
}
|
|
|
|
networkManager.DisconnectClient(context.SenderId);
|
|
return false;
|
|
}
|
|
reader.ReadValue(out ConfigHash);
|
|
|
|
if (!networkManager.NetworkConfig.CompareConfig(ConfigHash))
|
|
{
|
|
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarning($"{nameof(NetworkConfig)} mismatch. The configuration between the server and client does not match");
|
|
}
|
|
|
|
networkManager.DisconnectClient(context.SenderId);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
public void Handle(ref NetworkContext context)
|
|
{
|
|
var networkManager = (NetworkManager)context.SystemOwner;
|
|
var senderId = context.SenderId;
|
|
|
|
// DAHost mocking the service logic to disconnect clients trying to connect with a lower session version
|
|
if (networkManager.DAHost)
|
|
{
|
|
if (ClientConfig.RemoteClientSessionVersion < networkManager.SessionConfig.SessionVersion)
|
|
{
|
|
//Disconnect with reason
|
|
networkManager.ConnectionManager.DisconnectClient(senderId, InvalidSessionVersionMessage);
|
|
return;
|
|
}
|
|
}
|
|
|
|
if (networkManager.ConnectionManager.PendingClients.TryGetValue(senderId, out PendingClient client))
|
|
{
|
|
// Set to pending approval to prevent future connection requests from being approved
|
|
client.ConnectionState = PendingClient.State.PendingApproval;
|
|
}
|
|
|
|
if (networkManager.NetworkConfig.ConnectionApproval)
|
|
{
|
|
var messageRequest = this;
|
|
networkManager.ConnectionManager.ApproveConnection(ref messageRequest, ref context);
|
|
}
|
|
else
|
|
{
|
|
var response = new NetworkManager.ConnectionApprovalResponse
|
|
{
|
|
Approved = true,
|
|
CreatePlayerObject = networkManager.DistributedAuthorityMode && networkManager.AutoSpawnPlayerPrefabClientSide ? false : networkManager.NetworkConfig.PlayerPrefab != null
|
|
};
|
|
networkManager.ConnectionManager.HandleConnectionApproval(senderId, response);
|
|
}
|
|
}
|
|
}
|
|
}
|