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] - 2024-09-12 ### Added - Added tooltips for all of the `NetworkObject` component's properties. (#3052) - Added message size validation to named and unnamed message sending functions for better error messages. (#3049) - Added "Check for NetworkObject Component" property to the Multiplayer->Netcode for GameObjects project settings. When disabled, this will bypass the in-editor `NetworkObject` check on `NetworkBehaviour` components. (#3031) - Added `NetworkTransform.SwitchTransformSpaceWhenParented` property that, when enabled, will handle the world to local, local to world, and local to local transform space transitions when interpolation is enabled. (#3013) - Added `NetworkTransform.TickSyncChildren` that, when enabled, will tick synchronize nested and/or child `NetworkTransform` components to eliminate any potential visual jittering that could occur if the `NetworkTransform` instances get into a state where their state updates are landing on different network ticks. (#3013) - Added `NetworkObject.AllowOwnerToParent` property to provide the ability to allow clients to parent owned objects when running in a client-server network topology. (#3013) - Added `NetworkObject.SyncOwnerTransformWhenParented` property to provide a way to disable applying the server's transform information in the parenting message on the client owner instance which can be useful for owner authoritative motion models. (#3013) - Added `NetcodeEditorBase` editor helper class to provide easier modification and extension of the SDK's components. (#3013) ### Fixed - Fixed issue where `NetworkAnimator` would send updates to non-observer clients. (#3057) - Fixed issue where an exception could occur when receiving a universal RPC for a `NetworkObject` that has been despawned. (#3052) - Fixed issue where a NetworkObject hidden from a client that is then promoted to be session owner was not being synchronized with newly joining clients.(#3051) - Fixed issue where clients could have a wrong time delta on `NetworkVariableBase` which could prevent from sending delta state updates. (#3045) - Fixed issue where setting a prefab hash value during connection approval but not having a player prefab assigned could cause an exception when spawning a player. (#3042) - Fixed issue where the `NetworkSpawnManager.HandleNetworkObjectShow` could throw an exception if one of the `NetworkObject` components to show was destroyed during the same frame. (#3030) - Fixed issue where the `NetworkManagerHelper` was continuing to check for hierarchy changes when in play mode. (#3026) - Fixed issue with newly/late joined clients and `NetworkTransform` synchronization of parented `NetworkObject` instances. (#3013) - Fixed issue with smooth transitions between transform spaces when interpolation is enabled (requires `NetworkTransform.SwitchTransformSpaceWhenParented` to be enabled). (#3013) ### Changed - Changed `NetworkTransformEditor` now uses `NetworkTransform` as the base type class to assure it doesn't display a foldout group when using the base `NetworkTransform` component class. (#3052) - Changed `NetworkAnimator.Awake` is now a protected virtual method. (#3052) - Changed when invoking `NetworkManager.ConnectionManager.DisconnectClient` during a distributed authority session a more appropriate message is logged. (#3052) - Changed `NetworkTransformEditor` so it now derives from `NetcodeEditorBase`. (#3013) - Changed `NetworkRigidbodyBaseEditor` so it now derives from `NetcodeEditorBase`. (#3013) - Changed `NetworkManagerEditor` so it now derives from `NetcodeEditorBase`. (#3013)
166 lines
7.5 KiB
C#
166 lines
7.5 KiB
C#
using UnityEngine;
|
|
|
|
namespace Unity.Netcode
|
|
{
|
|
internal struct ParentSyncMessage : INetworkMessage
|
|
{
|
|
public int Version => 0;
|
|
|
|
private const string k_Name = "DestroyObjectMessage";
|
|
|
|
public ulong NetworkObjectId;
|
|
|
|
private byte m_BitField;
|
|
|
|
public bool WorldPositionStays
|
|
{
|
|
get => ByteUtility.GetBit(m_BitField, 0);
|
|
set => ByteUtility.SetBit(ref m_BitField, 0, value);
|
|
}
|
|
|
|
//If(Metadata.IsReparented)
|
|
public bool IsLatestParentSet
|
|
{
|
|
get => ByteUtility.GetBit(m_BitField, 1);
|
|
set => ByteUtility.SetBit(ref m_BitField, 1, value);
|
|
}
|
|
|
|
//If(IsLatestParentSet)
|
|
public ulong? LatestParent;
|
|
|
|
// Is set when the parent should be removed (similar to IsReparented functionality but only for removing the parent)
|
|
public bool RemoveParent
|
|
{
|
|
get => ByteUtility.GetBit(m_BitField, 2);
|
|
set => ByteUtility.SetBit(ref m_BitField, 2, value);
|
|
}
|
|
|
|
public bool AuthorityApplied
|
|
{
|
|
get => ByteUtility.GetBit(m_BitField, 3);
|
|
set => ByteUtility.SetBit(ref m_BitField, 3, value);
|
|
}
|
|
|
|
// These additional properties are used to synchronize clients with the current position,
|
|
// rotation, and scale after parenting/de-parenting (world/local space relative). This
|
|
// allows users to control the final child's transform values without having to have a
|
|
// NetworkTransform component on the child. (i.e. picking something up)
|
|
public Vector3 Position;
|
|
public Quaternion Rotation;
|
|
public Vector3 Scale;
|
|
|
|
public void Serialize(FastBufferWriter writer, int targetVersion)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, NetworkObjectId);
|
|
writer.WriteValueSafe(m_BitField);
|
|
if (!RemoveParent)
|
|
{
|
|
if (IsLatestParentSet)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, LatestParent.Value);
|
|
}
|
|
}
|
|
|
|
// Whether parenting or removing a parent, we always update the position, rotation, and scale
|
|
writer.WriteValueSafe(Position);
|
|
writer.WriteValueSafe(Rotation);
|
|
writer.WriteValueSafe(Scale);
|
|
}
|
|
|
|
public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int receivedMessageVersion)
|
|
{
|
|
var networkManager = (NetworkManager)context.SystemOwner;
|
|
if (!networkManager.IsClient)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
ByteUnpacker.ReadValueBitPacked(reader, out NetworkObjectId);
|
|
reader.ReadValueSafe(out m_BitField);
|
|
if (!RemoveParent)
|
|
{
|
|
if (IsLatestParentSet)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out ulong latestParent);
|
|
LatestParent = latestParent;
|
|
}
|
|
}
|
|
|
|
// Whether parenting or removing a parent, we always update the position, rotation, and scale
|
|
reader.ReadValueSafe(out Position);
|
|
reader.ReadValueSafe(out Rotation);
|
|
reader.ReadValueSafe(out Scale);
|
|
|
|
// If the target NetworkObject does not exist =or= the target latest parent does not exist then defer the message
|
|
if (!networkManager.SpawnManager.SpawnedObjects.ContainsKey(NetworkObjectId) || (LatestParent.HasValue && !networkManager.SpawnManager.SpawnedObjects.ContainsKey(LatestParent.Value)))
|
|
{
|
|
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnSpawn, NetworkObjectId, reader, ref context, k_Name);
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public void Handle(ref NetworkContext context)
|
|
{
|
|
var networkManager = (NetworkManager)context.SystemOwner;
|
|
var networkObject = networkManager.SpawnManager.SpawnedObjects[NetworkObjectId];
|
|
|
|
// For either DA or Client-Server modes, parenting is only valid if the parent was owned by a different authority (i.e. AuthorityApplied) or the sender is from the owner (DA mode)
|
|
// or the server (client-server mode).
|
|
networkObject.AuthorityAppliedParenting = AuthorityApplied || context.SenderId == networkObject.OwnerClientId || context.SenderId == NetworkManager.ServerClientId;
|
|
if (!networkObject.AuthorityAppliedParenting && networkManager.LogLevel <= LogLevel.Normal)
|
|
{
|
|
NetworkLog.LogWarningServer($"Client-{context.SenderId} sent a ParentSyncMessage but is not the authority of {networkObject.gameObject.name}'s {nameof(NetworkObject)} component!");
|
|
// DANGO-TODO: Still determining if we should not apply this change (I am leaning towards not allowing it).
|
|
}
|
|
|
|
networkObject.SetNetworkParenting(LatestParent, WorldPositionStays);
|
|
networkObject.ApplyNetworkParenting(RemoveParent);
|
|
|
|
// This check is primarily for client-server network topologies when the motion model is owner authoritative:
|
|
// When SyncOwnerTransformWhenParented is enabled, then always apply the transform values.
|
|
// When SyncOwnerTransformWhenParented is disabled, then only synchronize the transform on non-owner instances.
|
|
if (networkObject.SyncOwnerTransformWhenParented || (!networkObject.SyncOwnerTransformWhenParented && !networkObject.IsOwner))
|
|
{
|
|
// We set all of the transform values after parenting as they are
|
|
// the values of the server-side post-parenting transform values
|
|
if (!WorldPositionStays)
|
|
{
|
|
networkObject.transform.localPosition = Position;
|
|
networkObject.transform.localRotation = Rotation;
|
|
}
|
|
else
|
|
{
|
|
networkObject.transform.position = Position;
|
|
networkObject.transform.rotation = Rotation;
|
|
}
|
|
networkObject.transform.localScale = Scale;
|
|
}
|
|
|
|
// If in distributed authority mode and we are running a DAHost and this is the DAHost, then forward the parent changed message to any remaining clients
|
|
if ((networkManager.DistributedAuthorityMode && !networkManager.CMBServiceConnection && networkManager.DAHost) || (networkObject.AllowOwnerToParent && context.SenderId == networkObject.OwnerClientId && networkManager.IsServer))
|
|
{
|
|
var size = 0;
|
|
var message = this;
|
|
|
|
foreach (var client in networkManager.ConnectedClients)
|
|
{
|
|
if (client.Value.ClientId == networkObject.OwnerClientId || client.Value.ClientId == networkManager.LocalClientId)
|
|
{
|
|
continue;
|
|
}
|
|
if (networkObject.IsNetworkVisibleTo(client.Value.ClientId))
|
|
{
|
|
size = networkManager.ConnectionManager.SendMessage(ref message, NetworkDelivery.ReliableSequenced, client.Value.ClientId);
|
|
networkManager.NetworkMetrics.TrackOwnershipChangeSent(client.Key, networkObject, size);
|
|
}
|
|
else
|
|
{
|
|
Debug.Log($"[DAHost][ParentingProxy] Client-{client.Value.ClientId} has no visibility to {networkObject.name}!");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|