com.unity.netcode.gameobjects@1.1.0
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.1.0] - 2022-10-21 ### Added - Added `NetworkManager.IsApproved` flag that is set to `true` a client has been approved.(#2261) - `UnityTransport` now provides a way to set the Relay server data directly from the `RelayServerData` structure (provided by the Unity Transport package) throuh its `SetRelayServerData` method. This allows making use of the new APIs in UTP 1.3 that simplify integration of the Relay SDK. (#2235) - IPv6 is now supported for direct connections when using `UnityTransport`. (#2232) - Added WebSocket support when using UTP 2.0 with `UseWebSockets` property in the `UnityTransport` component of the `NetworkManager` allowing to pick WebSockets for communication. When building for WebGL, this selection happens automatically. (#2201) - Added position, rotation, and scale to the `ParentSyncMessage` which provides users the ability to specify the final values on the server-side when `OnNetworkObjectParentChanged` is invoked just before the message is created (when the `Transform` values are applied to the message). (#2146) - Added `NetworkObject.TryRemoveParent` method for convenience purposes opposed to having to cast null to either `GameObject` or `NetworkObject`. (#2146) ### Changed - Updated `UnityTransport` dependency on `com.unity.transport` to 1.3.0. (#2231) - The send queues of `UnityTransport` are now dynamically-sized. This means that there shouldn't be any need anymore to tweak the 'Max Send Queue Size' value. In fact, this field is now removed from the inspector and will not be serialized anymore. It is still possible to set it manually using the `MaxSendQueueSize` property, but it is not recommended to do so aside from some specific needs (e.g. limiting the amount of memory used by the send queues in very constrained environments). (#2212) - As a consequence of the above change, the `UnityTransport.InitialMaxSendQueueSize` field is now deprecated. There is no default value anymore since send queues are dynamically-sized. (#2212) - The debug simulator in `UnityTransport` is now non-deterministic. Its random number generator used to be seeded with a constant value, leading to the same pattern of packet drops, delays, and jitter in every run. (#2196) - `NetworkVariable<>` now supports managed `INetworkSerializable` types, as well as other managed types with serialization/deserialization delegates registered to `UserNetworkVariableSerialization<T>.WriteValue` and `UserNetworkVariableSerialization<T>.ReadValue` (#2219) - `NetworkVariable<>` and `BufferSerializer<BufferSerializerReader>` now deserialize `INetworkSerializable` types in-place, rather than constructing new ones. (#2219) ### Fixed - Fixed `NetworkManager.ApprovalTimeout` will not timeout due to slower client synchronization times as it now uses the added `NetworkManager.IsApproved` flag to determined if the client has been approved or not.(#2261) - Fixed issue caused when changing ownership of objects hidden to some clients (#2242) - Fixed issue where an in-scene placed NetworkObject would not invoke NetworkBehaviour.OnNetworkSpawn if the GameObject was disabled when it was despawned. (#2239) - Fixed issue where clients were not rebuilding the `NetworkConfig` hash value for each unique connection request. (#2226) - Fixed the issue where player objects were not taking the `DontDestroyWithOwner` property into consideration when a client disconnected. (#2225) - Fixed issue where `SceneEventProgress` would not complete if a client late joins while it is still in progress. (#2222) - Fixed issue where `SceneEventProgress` would not complete if a client disconnects. (#2222) - Fixed issues with detecting if a `SceneEventProgress` has timed out. (#2222) - Fixed issue #1924 where `UnityTransport` would fail to restart after a first failure (even if what caused the initial failure was addressed). (#2220) - Fixed issue where `NetworkTransform.SetStateServerRpc` and `NetworkTransform.SetStateClientRpc` were not honoring local vs world space settings when applying the position and rotation. (#2203) - Fixed ILPP `TypeLoadException` on WebGL on MacOS Editor and potentially other platforms. (#2199) - Implicit conversion of NetworkObjectReference to GameObject will now return null instead of throwing an exception if the referenced object could not be found (i.e., was already despawned) (#2158) - Fixed warning resulting from a stray NetworkAnimator.meta file (#2153) - Fixed Connection Approval Timeout not working client side. (#2164) - Fixed issue where the `WorldPositionStays` parenting parameter was not being synchronized with clients. (#2146) - Fixed issue where parented in-scene placed `NetworkObject`s would fail for late joining clients. (#2146) - Fixed issue where scale was not being synchronized which caused issues with nested parenting and scale when `WorldPositionStays` was true. (#2146) - Fixed issue with `NetworkTransform.ApplyTransformToNetworkStateWithInfo` where it was not honoring axis sync settings when `NetworkTransformState.IsTeleportingNextFrame` was true. (#2146) - Fixed issue with `NetworkTransform.TryCommitTransformToServer` where it was not honoring the `InLocalSpace` setting. (#2146) - Fixed ClientRpcs always reporting in the profiler view as going to all clients, even when limited to a subset of clients by `ClientRpcParams`. (#2144) - Fixed RPC codegen failing to choose the correct extension methods for `FastBufferReader` and `FastBufferWriter` when the parameters were a generic type (i.e., List<int>) and extensions for multiple instantiations of that type have been defined (i.e., List<int> and List<string>) (#2142) - Fixed the issue where running a server (i.e. not host) the second player would not receive updates (unless a third player joined). (#2127) - Fixed issue where late-joining client transition synchronization could fail when more than one transition was occurring.(#2127) - Fixed throwing an exception in `OnNetworkUpdate` causing other `OnNetworkUpdate` calls to not be executed. (#1739) - Fixed synchronization when Time.timeScale is set to 0. This changes timing update to use unscaled deltatime. Now network updates rate are independent from the local time scale. (#2171) - Fixed not sending all NetworkVariables to all clients when a client connects to a server. (#1987) - Fixed IsOwner/IsOwnedByServer being wrong on the server after calling RemoveOwnership (#2211)
This commit is contained in:
Unity Technologies
@@ -213,11 +213,11 @@ namespace Unity.Netcode
|
||||
return;
|
||||
}
|
||||
|
||||
networkObject.OwnerClientId = NetworkManager.ServerClientId;
|
||||
|
||||
// Server removes the entry and takes over ownership before notifying
|
||||
UpdateOwnershipTable(networkObject, NetworkManager.ServerClientId, true);
|
||||
|
||||
networkObject.OwnerClientId = NetworkManager.ServerClientId;
|
||||
|
||||
var message = new ChangeOwnershipMessage
|
||||
{
|
||||
NetworkObjectId = networkObject.NetworkObjectId,
|
||||
@@ -278,11 +278,14 @@ namespace Unity.Netcode
|
||||
NetworkObjectId = networkObject.NetworkObjectId,
|
||||
OwnerClientId = networkObject.OwnerClientId
|
||||
};
|
||||
var size = NetworkManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, NetworkManager.ConnectedClientsIds);
|
||||
|
||||
foreach (var client in NetworkManager.ConnectedClients)
|
||||
{
|
||||
NetworkManager.NetworkMetrics.TrackOwnershipChangeSent(client.Key, networkObject, size);
|
||||
if (networkObject.IsNetworkVisibleTo(client.Value.ClientId))
|
||||
{
|
||||
var size = NetworkManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, client.Value.ClientId);
|
||||
NetworkManager.NetworkMetrics.TrackOwnershipChangeSent(client.Key, networkObject, size);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -314,48 +317,33 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Should only run on the client
|
||||
/// Creates a local NetowrkObject to be spawned.
|
||||
/// </summary>
|
||||
internal NetworkObject CreateLocalNetworkObject(bool isSceneObject, uint globalObjectIdHash, ulong ownerClientId, ulong? parentNetworkId, int? networkSceneHandle, Vector3? position, Quaternion? rotation, bool isReparented = false)
|
||||
/// <remarks>
|
||||
/// For most cases this is client-side only, with the exception of when the server
|
||||
/// is spawning a player.
|
||||
/// </remarks>
|
||||
internal NetworkObject CreateLocalNetworkObject(NetworkObject.SceneObject sceneObject)
|
||||
{
|
||||
NetworkObject parentNetworkObject = null;
|
||||
NetworkObject networkObject = null;
|
||||
var globalObjectIdHash = sceneObject.Header.Hash;
|
||||
var position = sceneObject.Header.HasTransform ? sceneObject.Transform.Position : default;
|
||||
var rotation = sceneObject.Header.HasTransform ? sceneObject.Transform.Rotation : default;
|
||||
var scale = sceneObject.Header.HasTransform ? sceneObject.Transform.Scale : default;
|
||||
var parentNetworkId = sceneObject.Header.HasParent ? sceneObject.ParentObjectId : default;
|
||||
var worldPositionStays = sceneObject.Header.HasParent ? sceneObject.WorldPositionStays : true;
|
||||
var isSpawnedByPrefabHandler = false;
|
||||
|
||||
if (parentNetworkId != null && !isReparented)
|
||||
{
|
||||
if (SpawnedObjects.TryGetValue(parentNetworkId.Value, out NetworkObject networkObject))
|
||||
{
|
||||
parentNetworkObject = networkObject;
|
||||
}
|
||||
else
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogWarning("Cannot find parent. Parent objects always have to be spawned and replicated BEFORE the child");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!NetworkManager.NetworkConfig.EnableSceneManagement || !isSceneObject)
|
||||
// If scene management is disabled or the NetworkObject was dynamically spawned
|
||||
if (!NetworkManager.NetworkConfig.EnableSceneManagement || !sceneObject.Header.IsSceneObject)
|
||||
{
|
||||
// If the prefab hash has a registered INetworkPrefabInstanceHandler derived class
|
||||
if (NetworkManager.PrefabHandler.ContainsHandler(globalObjectIdHash))
|
||||
{
|
||||
// Let the handler spawn the NetworkObject
|
||||
var networkObject = NetworkManager.PrefabHandler.HandleNetworkPrefabSpawn(globalObjectIdHash, ownerClientId, position.GetValueOrDefault(Vector3.zero), rotation.GetValueOrDefault(Quaternion.identity));
|
||||
|
||||
networkObject = NetworkManager.PrefabHandler.HandleNetworkPrefabSpawn(globalObjectIdHash, sceneObject.Header.OwnerClientId, position, rotation);
|
||||
networkObject.NetworkManagerOwner = NetworkManager;
|
||||
|
||||
if (parentNetworkObject != null)
|
||||
{
|
||||
networkObject.transform.SetParent(parentNetworkObject.transform, true);
|
||||
}
|
||||
|
||||
if (NetworkSceneManager.IsSpawnedObjectsPendingInDontDestroyOnLoad)
|
||||
{
|
||||
UnityEngine.Object.DontDestroyOnLoad(networkObject.gameObject);
|
||||
}
|
||||
|
||||
return networkObject;
|
||||
isSpawnedByPrefabHandler = true;
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -383,31 +371,18 @@ namespace Unity.Netcode
|
||||
{
|
||||
NetworkLog.LogError($"Failed to create object locally. [{nameof(globalObjectIdHash)}={globalObjectIdHash}]. {nameof(NetworkPrefab)} could not be found. Is the prefab registered with {nameof(NetworkManager)}?");
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
// Otherwise, instantiate an instance of the NetworkPrefab linked to the prefabHash
|
||||
var networkObject = ((position == null && rotation == null) ? UnityEngine.Object.Instantiate(networkPrefabReference) : UnityEngine.Object.Instantiate(networkPrefabReference, position.GetValueOrDefault(Vector3.zero), rotation.GetValueOrDefault(Quaternion.identity))).GetComponent<NetworkObject>();
|
||||
|
||||
networkObject.NetworkManagerOwner = NetworkManager;
|
||||
|
||||
if (parentNetworkObject != null)
|
||||
else
|
||||
{
|
||||
networkObject.transform.SetParent(parentNetworkObject.transform, true);
|
||||
// Create prefab instance
|
||||
networkObject = UnityEngine.Object.Instantiate(networkPrefabReference).GetComponent<NetworkObject>();
|
||||
networkObject.NetworkManagerOwner = NetworkManager;
|
||||
}
|
||||
|
||||
if (NetworkSceneManager.IsSpawnedObjectsPendingInDontDestroyOnLoad)
|
||||
{
|
||||
UnityEngine.Object.DontDestroyOnLoad(networkObject.gameObject);
|
||||
}
|
||||
|
||||
return networkObject;
|
||||
}
|
||||
}
|
||||
else
|
||||
else // Get the in-scene placed NetworkObject
|
||||
{
|
||||
var networkObject = NetworkManager.SceneManager.GetSceneRelativeInSceneNetworkObject(globalObjectIdHash, networkSceneHandle);
|
||||
networkObject = NetworkManager.SceneManager.GetSceneRelativeInSceneNetworkObject(globalObjectIdHash, sceneObject.NetworkSceneHandle);
|
||||
|
||||
if (networkObject == null)
|
||||
{
|
||||
@@ -415,17 +390,78 @@ namespace Unity.Netcode
|
||||
{
|
||||
NetworkLog.LogError($"{nameof(NetworkPrefab)} hash was not found! In-Scene placed {nameof(NetworkObject)} soft synchronization failure for Hash: {globalObjectIdHash}!");
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
if (parentNetworkObject != null)
|
||||
// Since this NetworkObject is an in-scene placed NetworkObject, if it is disabled then enable it so
|
||||
// NetworkBehaviours will have their OnNetworkSpawn method invoked
|
||||
if (networkObject != null && !networkObject.gameObject.activeInHierarchy)
|
||||
{
|
||||
networkObject.transform.SetParent(parentNetworkObject.transform, true);
|
||||
networkObject.gameObject.SetActive(true);
|
||||
}
|
||||
}
|
||||
|
||||
if (networkObject != null)
|
||||
{
|
||||
// SPECIAL CASE:
|
||||
// This is a special case scenario where a late joining client has joined and loaded one or
|
||||
// more scenes that contain nested in-scene placed NetworkObject children yet the server's
|
||||
// synchronization information does not indicate the NetworkObject in question has a parent.
|
||||
// Under this scenario, we want to remove the parent before spawning and setting the transform values.
|
||||
if (sceneObject.Header.IsSceneObject && !sceneObject.Header.HasParent && networkObject.transform.parent != null)
|
||||
{
|
||||
// if the in-scene placed NetworkObject has a parent NetworkObject but the synchronization information does not
|
||||
// include parenting, then we need to force the removal of that parent
|
||||
if (networkObject.transform.parent.GetComponent<NetworkObject>() != null)
|
||||
{
|
||||
// remove the parent
|
||||
networkObject.ApplyNetworkParenting(true, true);
|
||||
}
|
||||
}
|
||||
|
||||
return networkObject;
|
||||
// Set the transform unless we were spawned by a prefab handler
|
||||
// Note: prefab handlers are provided the position and rotation
|
||||
// but it is up to the user to set those values
|
||||
if (sceneObject.Header.HasTransform && !isSpawnedByPrefabHandler)
|
||||
{
|
||||
if (worldPositionStays)
|
||||
{
|
||||
networkObject.transform.position = position;
|
||||
networkObject.transform.rotation = rotation;
|
||||
}
|
||||
else
|
||||
{
|
||||
networkObject.transform.localPosition = position;
|
||||
networkObject.transform.localRotation = rotation;
|
||||
}
|
||||
|
||||
// SPECIAL CASE:
|
||||
// Since players are created uniquely we don't apply scale because
|
||||
// the ConnectionApprovalResponse does not currently provide the
|
||||
// ability to specify scale. So, we just use the default scale of
|
||||
// the network prefab used to represent the player.
|
||||
// Note: not doing this would set the player's scale to zero since
|
||||
// that is the default value of Vector3.
|
||||
if (!sceneObject.Header.IsPlayerObject)
|
||||
{
|
||||
networkObject.transform.localScale = scale;
|
||||
}
|
||||
}
|
||||
|
||||
if (sceneObject.Header.HasParent)
|
||||
{
|
||||
// Go ahead and set network parenting properties
|
||||
networkObject.SetNetworkParenting(parentNetworkId, worldPositionStays);
|
||||
}
|
||||
|
||||
|
||||
// Dynamically spawned NetworkObjects that occur during a LoadSceneMode.Single load scene event are migrated into the DDOL
|
||||
// until the scene is loaded. They are then migrated back into the newly loaded and currently active scene.
|
||||
if (!sceneObject.Header.IsSceneObject && NetworkSceneManager.IsSpawnedObjectsPendingInDontDestroyOnLoad)
|
||||
{
|
||||
UnityEngine.Object.DontDestroyOnLoad(networkObject.gameObject);
|
||||
}
|
||||
}
|
||||
return networkObject;
|
||||
}
|
||||
|
||||
// Ran on both server and client
|
||||
@@ -545,7 +581,6 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
networkObject.SetCachedParent(networkObject.transform.parent);
|
||||
networkObject.ApplyNetworkParenting();
|
||||
NetworkObject.CheckOrphanChildren();
|
||||
|
||||
@@ -575,8 +610,6 @@ namespace Unity.Netcode
|
||||
};
|
||||
var size = NetworkManager.SendMessage(ref message, NetworkDelivery.ReliableFragmentedSequenced, clientId);
|
||||
NetworkManager.NetworkMetrics.TrackObjectSpawnSent(clientId, networkObject, size);
|
||||
|
||||
networkObject.MarkVariablesDirty(true);
|
||||
}
|
||||
|
||||
internal ulong? GetSpawnParentId(NetworkObject networkObject)
|
||||
@@ -745,15 +778,26 @@ namespace Unity.Netcode
|
||||
}
|
||||
|
||||
// If we are shutting down the NetworkManager, then ignore resetting the parent
|
||||
if (!NetworkManager.ShutdownInProgress)
|
||||
// and only attempt to remove the child's parent on the server-side
|
||||
if (!NetworkManager.ShutdownInProgress && NetworkManager.IsServer)
|
||||
{
|
||||
// Move child NetworkObjects to the root when parent NetworkObject is destroyed
|
||||
foreach (var spawnedNetObj in SpawnedObjectsList)
|
||||
{
|
||||
var (isReparented, latestParent) = spawnedNetObj.GetNetworkParenting();
|
||||
if (isReparented && latestParent == networkObject.NetworkObjectId)
|
||||
var latestParent = spawnedNetObj.GetNetworkParenting();
|
||||
if (latestParent.HasValue && latestParent.Value == networkObject.NetworkObjectId)
|
||||
{
|
||||
spawnedNetObj.gameObject.transform.parent = null;
|
||||
// Try to remove the parent using the cached WorldPositioNStays value
|
||||
// Note: WorldPositionStays will still default to true if this was an
|
||||
// in-scene placed NetworkObject and parenting was predefined in the
|
||||
// scene via the editor.
|
||||
if (!spawnedNetObj.TryRemoveParentCachedWorldPositionStays())
|
||||
{
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
NetworkLog.LogError($"{nameof(NetworkObject)} #{spawnedNetObj.NetworkObjectId} could not be moved to the root when its parent {nameof(NetworkObject)} #{networkObject.NetworkObjectId} was being destroyed");
|
||||
}
|
||||
}
|
||||
|
||||
if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user