com.unity.netcode.gameobjects@1.4.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.4.0] - 2023-04-10 ### Added - Added a way to access the GlobalObjectIdHash via PrefabIdHash for use in the Connection Approval Callback. (#2437) - Added `OnServerStarted` and `OnServerStopped` events that will trigger only on the server (or host player) to notify that the server just started or is no longer active (#2420) - Added `OnClientStarted` and `OnClientStopped` events that will trigger only on the client (or host player) to notify that the client just started or is no longer active (#2420) - Added `NetworkTransform.UseHalfFloatPrecision` property that, when enabled, will use half float values for position, rotation, and scale. This yields a 50% bandwidth savings a the cost of precision. (#2388) - Added `NetworkTransform.UseQuaternionSynchronization` property that, when enabled, will synchronize the entire quaternion. (#2388) - Added `NetworkTransform.UseQuaternionCompression` property that, when enabled, will use a smallest three implementation reducing a full quaternion synchronization update to the size of an unsigned integer. (#2388) - Added `NetworkTransform.SlerpPosition` property that, when enabled along with interpolation being enabled, will interpolate using `Vector3.Slerp`. (#2388) - Added `BufferedLinearInterpolatorVector3` that replaces the float version, is now used by `NetworkTransform`, and provides the ability to enable or disable `Slerp`. (#2388) - Added `HalfVector3` used for scale when half float precision is enabled. (#2388) - Added `HalfVector4` used for rotation when half float precision and quaternion synchronization is enabled. (#2388) - Added `HalfVector3DeltaPosition` used for position when half float precision is enabled. This handles loss in position precision by updating only the delta position as opposed to the full position. (#2388) - Added `NetworkTransform.GetSpaceRelativePosition` and `NetworkTransform.GetSpaceRelativeRotation` helper methods to return the proper values depending upon whether local or world space. (#2388) - Added `NetworkTransform.OnAuthorityPushTransformState` virtual method that is invoked just prior to sending the `NetworkTransformState` to non-authoritative instances. This provides users with the ability to obtain more precise delta values for prediction related calculations. (#2388) - Added `NetworkTransform.OnNetworkTransformStateUpdated` virtual method that is invoked just after the authoritative `NetworkTransformState` is applied. This provides users with the ability to obtain more precise delta values for prediction related calculations. (#2388) - Added `NetworkTransform.OnInitialize`virtual method that is invoked after the `NetworkTransform` has been initialized or re-initialized when ownership changes. This provides for a way to make adjustments when `NetworkTransform` is initialized (i.e. resetting client prediction etc) (#2388) - Added `NetworkObject.SynchronizeTransform` property (default is true) that provides users with another way to help with bandwidth optimizations where, when set to false, the `NetworkObject`'s associated transform will not be included when spawning and/or synchronizing late joining players. (#2388) - Added `NetworkSceneManager.ActiveSceneSynchronizationEnabled` property, disabled by default, that enables client synchronization of server-side active scene changes. (#2383) - Added `NetworkObject.ActiveSceneSynchronization`, disabled by default, that will automatically migrate a `NetworkObject` to a newly assigned active scene. (#2383) - Added `NetworkObject.SceneMigrationSynchronization`, enabled by default, that will synchronize client(s) when a `NetworkObject` is migrated into a new scene on the server side via `SceneManager.MoveGameObjectToScene`. (#2383) ### Changed - Made sure the `CheckObjectVisibility` delegate is checked and applied, upon `NetworkShow` attempt. Found while supporting (#2454), although this is not a fix for this (already fixed) issue. (#2463) - Changed `NetworkTransform` authority handles delta checks on each new network tick and no longer consumes processing cycles checking for deltas for all frames in-between ticks. (#2388) - Changed the `NetworkTransformState` structure is now public and now has public methods that provide access to key properties of the `NetworkTransformState` structure. (#2388) - Changed `NetworkTransform` interpolation adjusts its interpolation "ticks ago" to be 2 ticks latent if it is owner authoritative and the instance is not the server or 1 tick latent if the instance is the server and/or is server authoritative. (#2388) - Updated `NetworkSceneManager` to migrate dynamically spawned `NetworkObject`s with `DestroyWithScene` set to false into the active scene if their current scene is unloaded. (#2383) - Updated the server to synchronize its local `NetworkSceneManager.ClientSynchronizationMode` during the initial client synchronization. (#2383) ### Fixed - Fixed issue where during client synchronization the synchronizing client could receive a ObjectSceneChanged message before the client-side NetworkObject instance had been instantiated and spawned. (#2502) - Fixed issue where `NetworkAnimator` was building client RPC parameters to exclude the host from sending itself messages but was not including it in the ClientRpc parameters. (#2492) - Fixed issue where `NetworkAnimator` was not properly detecting and synchronizing cross fade initiated transitions. (#2481) - Fixed issue where `NetworkAnimator` was not properly synchronizing animation state updates. (#2481) - Fixed float NetworkVariables not being rendered properly in the inspector of NetworkObjects. (#2441) - Fixed an issue where Named Message Handlers could remove themselves causing an exception when the metrics tried to access the name of the message.(#2426) - Fixed registry of public `NetworkVariable`s in derived `NetworkBehaviour`s (#2423) - Fixed issue where runtime association of `Animator` properties to `AnimationCurve`s would cause `NetworkAnimator` to attempt to update those changes. (#2416) - Fixed issue where `NetworkAnimator` would not check if its associated `Animator` was valid during serialization and would spam exceptions in the editor console. (#2416) - Fixed issue with a child's rotation rolling over when interpolation is enabled on a `NetworkTransform`. Now using half precision or full quaternion synchronization will always update all axis. (#2388) - Fixed issue where `NetworkTransform` was not setting the teleport flag when the `NetworkTransform.InLocalSpace` value changed. This issue only impacted `NetworkTransform` when interpolation was enabled. (#2388) - Fixed issue when the `NetworkSceneManager.ClientSynchronizationMode` is `LoadSceneMode.Additive` and the server changes the currently active scene prior to a client connecting then upon a client connecting and being synchronized the NetworkSceneManager would clear its internal ScenePlacedObjects list that could already be populated. (#2383) - Fixed issue where a client would load duplicate scenes of already preloaded scenes during the initial client synchronization and `NetworkSceneManager.ClientSynchronizationMode` was set to `LoadSceneMode.Additive`. (#2383)
This commit is contained in:
Unity Technologies
@@ -1,5 +1,5 @@
|
||||
using System.Collections.Generic;
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using Unity.Collections;
|
||||
using UnityEngine.SceneManagement;
|
||||
@@ -80,6 +80,16 @@ namespace Unity.Netcode
|
||||
/// <b>Event Notification:</b> Both server and client receive a local notification.
|
||||
/// </summary>
|
||||
SynchronizeComplete,
|
||||
/// <summary>
|
||||
/// Synchronizes clients when the active scene has changed
|
||||
/// See: <see cref="NetworkObject.ActiveSceneSynchronization"/>
|
||||
/// </summary>
|
||||
ActiveSceneChanged,
|
||||
/// <summary>
|
||||
/// Synchronizes clients when one or more NetworkObjects are migrated into a new scene
|
||||
/// See: <see cref="NetworkObject.SceneMigrationSynchronization"/>
|
||||
/// </summary>
|
||||
ObjectSceneChanged,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -94,7 +104,7 @@ namespace Unity.Netcode
|
||||
internal ForceNetworkSerializeByMemcpy<Guid> SceneEventProgressId;
|
||||
internal uint SceneEventId;
|
||||
|
||||
|
||||
internal uint ActiveSceneHash;
|
||||
internal uint SceneHash;
|
||||
internal int SceneHandle;
|
||||
|
||||
@@ -139,6 +149,8 @@ namespace Unity.Netcode
|
||||
internal Queue<uint> ScenesToSynchronize;
|
||||
internal Queue<uint> SceneHandlesToSynchronize;
|
||||
|
||||
internal LoadSceneMode ClientSynchronizationMode;
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Server Side:
|
||||
@@ -315,6 +327,8 @@ namespace Unity.Netcode
|
||||
case SceneEventType.ReSynchronize:
|
||||
case SceneEventType.LoadEventCompleted:
|
||||
case SceneEventType.UnloadEventCompleted:
|
||||
case SceneEventType.ActiveSceneChanged:
|
||||
case SceneEventType.ObjectSceneChanged:
|
||||
{
|
||||
return true;
|
||||
}
|
||||
@@ -384,6 +398,18 @@ namespace Unity.Netcode
|
||||
// Write the scene event type
|
||||
writer.WriteValueSafe(SceneEventType);
|
||||
|
||||
if (SceneEventType == SceneEventType.ActiveSceneChanged)
|
||||
{
|
||||
writer.WriteValueSafe(ActiveSceneHash);
|
||||
return;
|
||||
}
|
||||
|
||||
if (SceneEventType == SceneEventType.ObjectSceneChanged)
|
||||
{
|
||||
SerializeObjectsMovedIntoNewScene(writer);
|
||||
return;
|
||||
}
|
||||
|
||||
// Write the scene loading mode
|
||||
writer.WriteValueSafe((byte)LoadSceneMode);
|
||||
|
||||
@@ -392,6 +418,10 @@ namespace Unity.Netcode
|
||||
{
|
||||
writer.WriteValueSafe(SceneEventProgressId);
|
||||
}
|
||||
else
|
||||
{
|
||||
writer.WriteValueSafe(ClientSynchronizationMode);
|
||||
}
|
||||
|
||||
// Write the scene index and handle
|
||||
writer.WriteValueSafe(SceneHash);
|
||||
@@ -401,6 +431,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
case SceneEventType.Synchronize:
|
||||
{
|
||||
writer.WriteValueSafe(ActiveSceneHash);
|
||||
WriteSceneSynchronizationData(writer);
|
||||
break;
|
||||
}
|
||||
@@ -445,7 +476,7 @@ namespace Unity.Netcode
|
||||
// Size Place Holder -- Start
|
||||
// !!NOTE!!: Since this is a placeholder to be set after we know how much we have written,
|
||||
// for stream offset purposes this MUST not be a packed value!
|
||||
writer.WriteValueSafe((int)0);
|
||||
writer.WriteValueSafe(0);
|
||||
int totalBytes = 0;
|
||||
|
||||
// Write the number of NetworkObjects we are serializing
|
||||
@@ -458,7 +489,7 @@ namespace Unity.Netcode
|
||||
var sceneObject = m_NetworkObjectsSync[i].GetMessageSceneObject(TargetClientId);
|
||||
sceneObject.Serialize(writer);
|
||||
var noStop = writer.Position;
|
||||
totalBytes += (int)(noStop - noStart);
|
||||
totalBytes += noStop - noStart;
|
||||
}
|
||||
|
||||
// Write the number of despawned in-scene placed NetworkObjects
|
||||
@@ -470,7 +501,7 @@ namespace Unity.Netcode
|
||||
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync[i].GetSceneOriginHandle());
|
||||
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync[i].GlobalObjectIdHash);
|
||||
var noStop = writer.Position;
|
||||
totalBytes += (int)(noStop - noStart);
|
||||
totalBytes += noStop - noStart;
|
||||
}
|
||||
|
||||
// Size Place Holder -- End
|
||||
@@ -536,6 +567,26 @@ namespace Unity.Netcode
|
||||
internal void Deserialize(FastBufferReader reader)
|
||||
{
|
||||
reader.ReadValueSafe(out SceneEventType);
|
||||
if (SceneEventType == SceneEventType.ActiveSceneChanged)
|
||||
{
|
||||
reader.ReadValueSafe(out ActiveSceneHash);
|
||||
return;
|
||||
}
|
||||
|
||||
if (SceneEventType == SceneEventType.ObjectSceneChanged)
|
||||
{
|
||||
// Defer these scene event types if a client hasn't finished synchronizing
|
||||
if (!m_NetworkManager.IsConnectedClient)
|
||||
{
|
||||
DeferObjectsMovedIntoNewScene(reader);
|
||||
}
|
||||
else
|
||||
{
|
||||
DeserializeObjectsMovedIntoNewScene(reader);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
reader.ReadValueSafe(out byte loadSceneMode);
|
||||
LoadSceneMode = (LoadSceneMode)loadSceneMode;
|
||||
|
||||
@@ -543,6 +594,10 @@ namespace Unity.Netcode
|
||||
{
|
||||
reader.ReadValueSafe(out SceneEventProgressId);
|
||||
}
|
||||
else
|
||||
{
|
||||
reader.ReadValueSafe(out ClientSynchronizationMode);
|
||||
}
|
||||
|
||||
reader.ReadValueSafe(out SceneHash);
|
||||
reader.ReadValueSafe(out SceneHandle);
|
||||
@@ -551,6 +606,7 @@ namespace Unity.Netcode
|
||||
{
|
||||
case SceneEventType.Synchronize:
|
||||
{
|
||||
reader.ReadValueSafe(out ActiveSceneHash);
|
||||
CopySceneSynchronizationData(reader);
|
||||
break;
|
||||
}
|
||||
@@ -939,6 +995,143 @@ namespace Unity.Netcode
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Serialize scene handles and associated NetworkObjects that were migrated
|
||||
/// into a new scene.
|
||||
/// </summary>
|
||||
private void SerializeObjectsMovedIntoNewScene(FastBufferWriter writer)
|
||||
{
|
||||
var sceneManager = m_NetworkManager.SceneManager;
|
||||
// Write the number of scene handles
|
||||
writer.WriteValueSafe(sceneManager.ObjectsMigratedIntoNewScene.Count);
|
||||
foreach (var sceneHandleObjects in sceneManager.ObjectsMigratedIntoNewScene)
|
||||
{
|
||||
// Write the scene handle
|
||||
writer.WriteValueSafe(sceneHandleObjects.Key);
|
||||
// Write the number of NetworkObjectIds to expect
|
||||
writer.WriteValueSafe(sceneHandleObjects.Value.Count);
|
||||
foreach (var networkObject in sceneHandleObjects.Value)
|
||||
{
|
||||
writer.WriteValueSafe(networkObject.NetworkObjectId);
|
||||
}
|
||||
}
|
||||
// Once we are done, clear the table
|
||||
sceneManager.ObjectsMigratedIntoNewScene.Clear();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Deserialize scene handles and associated NetworkObjects that need to
|
||||
/// be migrated into a new scene.
|
||||
/// </summary>
|
||||
private void DeserializeObjectsMovedIntoNewScene(FastBufferReader reader)
|
||||
{
|
||||
var sceneManager = m_NetworkManager.SceneManager;
|
||||
var spawnManager = m_NetworkManager.SpawnManager;
|
||||
// Just always assure this has no entries
|
||||
sceneManager.ObjectsMigratedIntoNewScene.Clear();
|
||||
var numberOfScenes = 0;
|
||||
var sceneHandle = 0;
|
||||
var objectCount = 0;
|
||||
var networkObjectId = (ulong)0;
|
||||
reader.ReadValueSafe(out numberOfScenes);
|
||||
for (int i = 0; i < numberOfScenes; i++)
|
||||
{
|
||||
reader.ReadValueSafe(out sceneHandle);
|
||||
sceneManager.ObjectsMigratedIntoNewScene.Add(sceneHandle, new List<NetworkObject>());
|
||||
reader.ReadValueSafe(out objectCount);
|
||||
for (int j = 0; j < objectCount; j++)
|
||||
{
|
||||
reader.ReadValueSafe(out networkObjectId);
|
||||
if (!spawnManager.SpawnedObjects.ContainsKey(networkObjectId))
|
||||
{
|
||||
NetworkLog.LogError($"[Object Scene Migration] Trying to synchronize NetworkObjectId ({networkObjectId}) but it was not spawned or no longer exists!!");
|
||||
continue;
|
||||
}
|
||||
// Add NetworkObject scene migration to ObjectsMigratedIntoNewScene dictionary that is processed
|
||||
//
|
||||
sceneManager.ObjectsMigratedIntoNewScene[sceneHandle].Add(spawnManager.SpawnedObjects[networkObjectId]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// While a client is synchronizing ObjectSceneChanged messages could be received.
|
||||
/// This defers any ObjectSceneChanged message processing to occur after the client
|
||||
/// has completed synchronization to assure the associated NetworkObjects being
|
||||
/// migrated to a new scene are instantiated and spawned.
|
||||
/// </summary>
|
||||
private void DeferObjectsMovedIntoNewScene(FastBufferReader reader)
|
||||
{
|
||||
var sceneManager = m_NetworkManager.SceneManager;
|
||||
var spawnManager = m_NetworkManager.SpawnManager;
|
||||
var numberOfScenes = 0;
|
||||
var sceneHandle = 0;
|
||||
var objectCount = 0;
|
||||
var networkObjectId = (ulong)0;
|
||||
|
||||
var deferredObjectsMovedEvent = new NetworkSceneManager.DeferredObjectsMovedEvent()
|
||||
{
|
||||
ObjectsMigratedTable = new Dictionary<int, List<ulong>>()
|
||||
};
|
||||
|
||||
reader.ReadValueSafe(out numberOfScenes);
|
||||
for (int i = 0; i < numberOfScenes; i++)
|
||||
{
|
||||
reader.ReadValueSafe(out sceneHandle);
|
||||
deferredObjectsMovedEvent.ObjectsMigratedTable.Add(sceneHandle, new List<ulong>());
|
||||
reader.ReadValueSafe(out objectCount);
|
||||
for (int j = 0; j < objectCount; j++)
|
||||
{
|
||||
reader.ReadValueSafe(out networkObjectId);
|
||||
deferredObjectsMovedEvent.ObjectsMigratedTable[sceneHandle].Add(networkObjectId);
|
||||
}
|
||||
}
|
||||
sceneManager.DeferredObjectsMovedEvents.Add(deferredObjectsMovedEvent);
|
||||
}
|
||||
|
||||
internal void ProcessDeferredObjectSceneChangedEvents()
|
||||
{
|
||||
var sceneManager = m_NetworkManager.SceneManager;
|
||||
var spawnManager = m_NetworkManager.SpawnManager;
|
||||
if (sceneManager.DeferredObjectsMovedEvents.Count == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
foreach (var objectsMovedEvent in sceneManager.DeferredObjectsMovedEvents)
|
||||
{
|
||||
foreach (var keyEntry in objectsMovedEvent.ObjectsMigratedTable)
|
||||
{
|
||||
if (!sceneManager.ObjectsMigratedIntoNewScene.ContainsKey(keyEntry.Key))
|
||||
{
|
||||
sceneManager.ObjectsMigratedIntoNewScene.Add(keyEntry.Key, new List<NetworkObject>());
|
||||
}
|
||||
foreach (var objectId in keyEntry.Value)
|
||||
{
|
||||
if (!spawnManager.SpawnedObjects.ContainsKey(objectId))
|
||||
{
|
||||
NetworkLog.LogWarning($"[Deferred][Object Scene Migration] Trying to synchronize NetworkObjectId ({objectId}) but it was not spawned or no longer exists!");
|
||||
continue;
|
||||
}
|
||||
var networkObject = spawnManager.SpawnedObjects[objectId];
|
||||
if (!sceneManager.ObjectsMigratedIntoNewScene[keyEntry.Key].Contains(networkObject))
|
||||
{
|
||||
sceneManager.ObjectsMigratedIntoNewScene[keyEntry.Key].Add(networkObject);
|
||||
}
|
||||
}
|
||||
}
|
||||
objectsMovedEvent.ObjectsMigratedTable.Clear();
|
||||
}
|
||||
|
||||
sceneManager.DeferredObjectsMovedEvents.Clear();
|
||||
|
||||
// If there are any pending objects to migrate, then migrate them
|
||||
if (sceneManager.ObjectsMigratedIntoNewScene.Count > 0)
|
||||
{
|
||||
sceneManager.MigrateNetworkObjectsIntoScenes();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Used to release the pooled network buffer
|
||||
/// </summary>
|
||||
|
||||
Reference in New Issue
Block a user