Skip to content

Commit fad2fea

Browse files
committed
Rename pass
SceneObject -- > SerializedObject GetMessageSceneObject --> Serialize AddSceneObject --> Deserialize
1 parent f624821 commit fad2fea

File tree

8 files changed

+86
-87
lines changed

8 files changed

+86
-87
lines changed

com.unity.netcode.gameobjects/Runtime/Connection/NetworkConnectionManager.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1119,15 +1119,15 @@ internal void ApprovedPlayerSpawn(ulong clientId, uint playerPrefabHash)
11191119

11201120
var message = new CreateObjectMessage
11211121
{
1122-
ObjectSynchronizerInfo = ConnectedClients[clientId].PlayerObject.GetMessageForSynchronization(clientPair.Key),
1122+
ObjectInfo = ConnectedClients[clientId].PlayerObject.Serialize(clientPair.Key),
11231123
IncludesSerializedObject = true,
11241124
};
11251125

1126-
message.ObjectSynchronizerInfo.Hash = playerPrefabHash;
1127-
message.ObjectSynchronizerInfo.IsSceneObject = false;
1128-
message.ObjectSynchronizerInfo.HasParent = false;
1129-
message.ObjectSynchronizerInfo.IsPlayerObject = true;
1130-
message.ObjectSynchronizerInfo.OwnerClientId = clientId;
1126+
message.ObjectInfo.Hash = playerPrefabHash;
1127+
message.ObjectInfo.IsSceneObject = false;
1128+
message.ObjectInfo.HasParent = false;
1129+
message.ObjectInfo.IsPlayerObject = true;
1130+
message.ObjectInfo.OwnerClientId = clientId;
11311131
var size = SendMessage(ref message, MessageDeliveryType<CreateObjectMessage>.DefaultDelivery, clientPair.Key);
11321132
NetworkManager.NetworkMetrics.TrackObjectSpawnSent(clientPair.Key, ConnectedClients[clientId].PlayerObject, size);
11331133
}

com.unity.netcode.gameobjects/Runtime/Core/NetworkObject.cs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2842,7 +2842,7 @@ public NetworkBehaviour GetNetworkBehaviourAtOrderIndex(ushort index)
28422842
return ChildNetworkBehaviours[index];
28432843
}
28442844

2845-
internal struct NetworkObjectSynchronizer
2845+
internal struct SerializedObject
28462846
{
28472847
public uint Hash;
28482848
public ulong NetworkObjectId;
@@ -3171,9 +3171,9 @@ internal void SynchronizeNetworkBehaviours<T>(ref BufferSerializer<T> serializer
31713171
}
31723172
}
31733173

3174-
internal NetworkObjectSynchronizer GetMessageForSynchronization(ulong targetClientId = NetworkManager.ServerClientId, bool syncObservers = false)
3174+
internal SerializedObject Serialize(ulong targetClientId = NetworkManager.ServerClientId, bool syncObservers = false)
31753175
{
3176-
var obj = new NetworkObjectSynchronizer
3176+
var obj = new SerializedObject
31773177
{
31783178
HasParent = transform.parent != null,
31793179
WorldPositionStays = m_CachedWorldPositionStays,
@@ -3227,7 +3227,7 @@ internal NetworkObjectSynchronizer GetMessageForSynchronization(ulong targetClie
32273227
syncScaleLocalSpaceRelative = obj.HasParent;
32283228
}
32293229

3230-
obj.Transform = new NetworkObjectSynchronizer.TransformData
3230+
obj.Transform = new SerializedObject.TransformData
32313231
{
32323232
// If we are parented and we have the m_CachedWorldPositionStays disabled, then use local space
32333233
// values as opposed world space values.
@@ -3246,35 +3246,35 @@ internal NetworkObjectSynchronizer GetMessageForSynchronization(ulong targetClie
32463246
}
32473247

32483248
/// <summary>
3249-
/// Used to deserialize a serialized <see cref="NetworkObjectSynchronizer"/> which occurs
3249+
/// Used to deserialize a serialized <see cref="SerializedObject"/> which occurs
32503250
/// when the client is approved or during a scene transition
32513251
/// </summary>
3252-
/// <param name="networkObjectSynchronizer">Deserialized scene object data</param>
3252+
/// <param name="serializedObject">Deserialized scene object data</param>
32533253
/// <param name="reader">FastBufferReader for the NetworkVariable data</param>
32543254
/// <param name="networkManager">NetworkManager instance</param>
32553255
/// <param name="invokedByMessage">will be true if invoked by CreateObjectMessage</param>
32563256
/// <returns>The deserialized NetworkObject or null if deserialization failed</returns>
3257-
internal static NetworkObject AddClientNetworkObject(in NetworkObjectSynchronizer networkObjectSynchronizer, FastBufferReader reader, NetworkManager networkManager, bool invokedByMessage = false)
3257+
internal static NetworkObject Deserialize(in SerializedObject serializedObject, FastBufferReader reader, NetworkManager networkManager, bool invokedByMessage = false)
32583258
{
3259-
var endOfSynchronizationData = reader.Position + networkObjectSynchronizer.SynchronizationDataSize;
3259+
var endOfSynchronizationData = reader.Position + serializedObject.SynchronizationDataSize;
32603260

32613261
byte[] instantiationData = null;
3262-
if (networkObjectSynchronizer.HasInstantiationData)
3262+
if (serializedObject.HasInstantiationData)
32633263
{
32643264
reader.ReadValueSafe(out instantiationData);
32653265
}
32663266

32673267

32683268
// Attempt to create a local NetworkObject
3269-
var networkObject = networkManager.SpawnManager.CreateLocalNetworkObject(networkObjectSynchronizer, instantiationData);
3269+
var networkObject = networkManager.SpawnManager.CreateLocalNetworkObject(serializedObject, instantiationData);
32703270

32713271

32723272
if (networkObject == null)
32733273
{
32743274
// Log the error that the NetworkObject failed to construct
32753275
if (networkManager.LogLevel <= LogLevel.Normal)
32763276
{
3277-
NetworkLog.LogError($"Failed to spawn {nameof(NetworkObject)} for Hash {networkObjectSynchronizer.Hash}.");
3277+
NetworkLog.LogError($"Failed to spawn {nameof(NetworkObject)} for Hash {serializedObject.Hash}.");
32783278
}
32793279

32803280
try
@@ -3295,7 +3295,7 @@ internal static NetworkObject AddClientNetworkObject(in NetworkObjectSynchronize
32953295

32963296
// This will get set again when the NetworkObject is spawned locally, but we set it here ahead of spawning
32973297
// in order to be able to determine which NetworkVariables the client will be allowed to read.
3298-
networkObject.OwnerClientId = networkObjectSynchronizer.OwnerClientId;
3298+
networkObject.OwnerClientId = serializedObject.OwnerClientId;
32993299

33003300
// Special Case: Invoke NetworkBehaviour.OnPreSpawn methods here before SynchronizeNetworkBehaviours
33013301
networkObject.InvokeBehaviourNetworkPreSpawn();
@@ -3323,7 +3323,7 @@ internal static NetworkObject AddClientNetworkObject(in NetworkObjectSynchronize
33233323
// being told we do not have a parent, then we want to clear the latest parent so it is not automatically
33243324
// "re-parented" to the original parent. This can happen if not unloading the scene and the parenting of
33253325
// the in-scene placed Networkobject changes several times over different sessions.
3326-
if (networkObjectSynchronizer.IsSceneObject && !networkObjectSynchronizer.HasParent && networkObject.m_LatestParent.HasValue)
3326+
if (serializedObject.IsSceneObject && !serializedObject.HasParent && networkObject.m_LatestParent.HasValue)
33273327
{
33283328
networkObject.m_LatestParent = null;
33293329
}
@@ -3336,19 +3336,19 @@ internal static NetworkObject AddClientNetworkObject(in NetworkObjectSynchronize
33363336

33373337
// Invoke the non-authority local spawn method
33383338
// (It also invokes post spawn and handles processing derferred messages)
3339-
networkManager.SpawnManager.NonAuthorityLocalSpawn(networkObject, networkObjectSynchronizer, networkObjectSynchronizer.DestroyWithScene);
3339+
networkManager.SpawnManager.NonAuthorityLocalSpawn(networkObject, serializedObject, serializedObject.DestroyWithScene);
33403340

3341-
if (networkObjectSynchronizer.SyncObservers)
3341+
if (serializedObject.SyncObservers)
33423342
{
3343-
foreach (var observer in networkObjectSynchronizer.Observers)
3343+
foreach (var observer in serializedObject.Observers)
33443344
{
33453345
networkObject.Observers.Add(observer);
33463346
}
33473347
}
33483348

33493349
if (networkManager.DistributedAuthorityMode)
33503350
{
3351-
networkObject.SpawnWithObservers = networkObjectSynchronizer.SpawnWithObservers;
3351+
networkObject.SpawnWithObservers = serializedObject.SpawnWithObservers;
33523352
}
33533353

33543354
// If this was not invoked by a message handler, we are in distributed authority mode, and we are spawning with observers or

com.unity.netcode.gameobjects/Runtime/Messaging/Messages/ConnectionApprovedMessage.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ public void Serialize(FastBufferWriter writer, int targetVersion)
160160
{
161161
sobj.Observers.Add(OwnerClientId);
162162
// In distributed authority mode, we send the currently known observers of each NetworkObject to the client being synchronized.
163-
var sceneObject = sobj.GetMessageForSynchronization(OwnerClientId, IsDistributedAuthority);
163+
var sceneObject = sobj.Serialize(OwnerClientId, IsDistributedAuthority);
164164
sceneObject.Serialize(writer);
165165
++sceneObjectCount;
166166
}
@@ -342,9 +342,9 @@ public void Handle(ref NetworkContext context)
342342
// to create a list to hold the data. This is a breach of convention for performance reasons.
343343
for (ushort i = 0; i < sceneObjectCount; i++)
344344
{
345-
var sceneObject = new NetworkObject.NetworkObjectSynchronizer();
345+
var sceneObject = new NetworkObject.SerializedObject();
346346
sceneObject.Deserialize(m_ReceivedSceneObjectData);
347-
NetworkObject.AddClientNetworkObject(sceneObject, m_ReceivedSceneObjectData, networkManager);
347+
NetworkObject.Deserialize(sceneObject, m_ReceivedSceneObjectData, networkManager);
348348
}
349349

350350
if (networkManager.AutoSpawnPlayerPrefabClientSide)

com.unity.netcode.gameobjects/Runtime/Messaging/Messages/CreateObjectMessage.cs

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ internal struct CreateObjectMessage : INetworkMessage
99

1010
private const string k_Name = "CreateObjectMessage";
1111

12-
public NetworkObject.NetworkObjectSynchronizer ObjectSynchronizerInfo;
12+
public NetworkObject.SerializedObject ObjectInfo;
1313
private FastBufferReader m_ReceivedNetworkVariableData;
1414

1515
// DA - NGO CMB SERVICE NOTES:
@@ -64,7 +64,7 @@ public void Serialize(FastBufferWriter writer, int targetVersion)
6464

6565
if (IncludesSerializedObject)
6666
{
67-
ObjectSynchronizerInfo.Serialize(writer);
67+
ObjectInfo.Serialize(writer);
6868
}
6969
else
7070
{
@@ -113,16 +113,16 @@ public bool Deserialize(FastBufferReader reader, ref NetworkContext context, int
113113

114114
if (IncludesSerializedObject)
115115
{
116-
ObjectSynchronizerInfo.Deserialize(reader);
116+
ObjectInfo.Deserialize(reader);
117117
}
118118
else
119119
{
120120
ByteUnpacker.ReadValuePacked(reader, out NetworkObjectId);
121121
}
122122

123-
if (!networkManager.NetworkConfig.ForceSamePrefabs && !networkManager.SpawnManager.HasPrefab(ObjectSynchronizerInfo))
123+
if (!networkManager.NetworkConfig.ForceSamePrefabs && !networkManager.SpawnManager.HasPrefab(ObjectInfo))
124124
{
125-
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnAddPrefab, ObjectSynchronizerInfo.Hash, reader, ref context, k_Name);
125+
networkManager.DeferredMessageManager.DeferMessage(IDeferredNetworkMessageManager.TriggerType.OnAddPrefab, ObjectInfo.Hash, reader, ref context, k_Name);
126126
return false;
127127
}
128128
m_ReceivedNetworkVariableData = reader;
@@ -136,18 +136,18 @@ public void Handle(ref NetworkContext context)
136136
// If a client receives a create object message and it is still synchronizing, then defer the object creation until it has finished synchronizing
137137
if (networkManager.SceneManager.ShouldDeferCreateObject())
138138
{
139-
networkManager.SceneManager.DeferCreateObject(context.SenderId, context.MessageSize, ObjectSynchronizerInfo, m_ReceivedNetworkVariableData, ObserverIds, NewObserverIds);
139+
networkManager.SceneManager.DeferCreateObject(context.SenderId, context.MessageSize, ObjectInfo, m_ReceivedNetworkVariableData, ObserverIds, NewObserverIds);
140140
}
141141
else
142142
{
143143
if (networkManager.DistributedAuthorityMode && !IncludesSerializedObject && UpdateObservers)
144144
{
145-
ObjectSynchronizerInfo = new NetworkObject.NetworkObjectSynchronizer()
145+
ObjectInfo = new NetworkObject.SerializedObject()
146146
{
147147
NetworkObjectId = NetworkObjectId,
148148
};
149149
}
150-
CreateObject(ref networkManager, context.SenderId, context.MessageSize, ObjectSynchronizerInfo, m_ReceivedNetworkVariableData, ObserverIds, NewObserverIds);
150+
CreateObject(ref networkManager, context.SenderId, context.MessageSize, ObjectInfo, m_ReceivedNetworkVariableData, ObserverIds, NewObserverIds);
151151
}
152152
}
153153

@@ -158,46 +158,46 @@ internal static void CreateObject(ref NetworkManager networkManager, ref Network
158158
var observerIds = deferredObjectCreation.ObserverIds;
159159
var newObserverIds = deferredObjectCreation.NewObserverIds;
160160
var messageSize = deferredObjectCreation.MessageSize;
161-
var sceneObject = deferredObjectCreation.NetworkObjectSynchronizer;
161+
var sceneObject = deferredObjectCreation.SerializedObject;
162162
var networkVariableData = deferredObjectCreation.FastBufferReader;
163163
CreateObject(ref networkManager, senderId, messageSize, sceneObject, networkVariableData, observerIds, newObserverIds);
164164
}
165165

166166
[MethodImpl(MethodImplOptions.AggressiveInlining)]
167-
internal static void CreateObject(ref NetworkManager networkManager, ulong senderId, uint messageSize, NetworkObject.NetworkObjectSynchronizer networkObjectSynchronizer, FastBufferReader networkVariableData, ulong[] observerIds, ulong[] newObserverIds)
167+
internal static void CreateObject(ref NetworkManager networkManager, ulong senderId, uint messageSize, NetworkObject.SerializedObject serializedObject, FastBufferReader networkVariableData, ulong[] observerIds, ulong[] newObserverIds)
168168
{
169169
var networkObject = (NetworkObject)null;
170170
try
171171
{
172172
if (!networkManager.DistributedAuthorityMode)
173173
{
174-
networkObject = NetworkObject.AddClientNetworkObject(networkObjectSynchronizer, networkVariableData, networkManager);
174+
networkObject = NetworkObject.Deserialize(serializedObject, networkVariableData, networkManager);
175175
}
176176
else
177177
{
178178
var hasObserverIdList = observerIds != null && observerIds.Length > 0;
179179
var hasNewObserverIdList = newObserverIds != null && newObserverIds.Length > 0;
180180
// Depending upon visibility of the NetworkObject and the client in question, it could be that
181181
// this client already has visibility of this NetworkObject
182-
if (networkManager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectSynchronizer.NetworkObjectId))
182+
if (networkManager.SpawnManager.SpawnedObjects.ContainsKey(serializedObject.NetworkObjectId))
183183
{
184184
// If so, then just get the local instance
185-
networkObject = networkManager.SpawnManager.SpawnedObjects[networkObjectSynchronizer.NetworkObjectId];
185+
networkObject = networkManager.SpawnManager.SpawnedObjects[serializedObject.NetworkObjectId];
186186

187187
// This should not happen, logging error just in case
188188
if (hasNewObserverIdList && newObserverIds.Contains(networkManager.LocalClientId))
189189
{
190-
NetworkLog.LogErrorServer($"[{nameof(CreateObjectMessage)}][Duplicate-Broadcast] Detected duplicated object creation for {networkObjectSynchronizer.NetworkObjectId}!");
190+
NetworkLog.LogErrorServer($"[{nameof(CreateObjectMessage)}][Duplicate-Broadcast] Detected duplicated object creation for {serializedObject.NetworkObjectId}!");
191191
}
192192
else // Trap to make sure the owner is not receiving any messages it sent
193193
if (networkManager.CMBServiceConnection && networkManager.LocalClientId == networkObject.OwnerClientId)
194194
{
195-
NetworkLog.LogWarning($"[{nameof(CreateObjectMessage)}][Client-{networkManager.LocalClientId}][Duplicate-CreateObjectMessage][Client Is Owner] Detected duplicated object creation for {networkObject.name}-{networkObjectSynchronizer.NetworkObjectId}!");
195+
NetworkLog.LogWarning($"[{nameof(CreateObjectMessage)}][Client-{networkManager.LocalClientId}][Duplicate-CreateObjectMessage][Client Is Owner] Detected duplicated object creation for {networkObject.name}-{serializedObject.NetworkObjectId}!");
196196
}
197197
}
198198
else
199199
{
200-
networkObject = NetworkObject.AddClientNetworkObject(networkObjectSynchronizer, networkVariableData, networkManager, true);
200+
networkObject = NetworkObject.Deserialize(serializedObject, networkVariableData, networkManager, true);
201201
}
202202

203203
// DA - NGO CMB SERVICE NOTES:
@@ -229,7 +229,7 @@ internal static void CreateObject(ref NetworkManager networkManager, ulong sende
229229

230230
var createObjectMessage = new CreateObjectMessage()
231231
{
232-
ObjectSynchronizerInfo = networkObjectSynchronizer,
232+
ObjectInfo = serializedObject,
233233
m_ReceivedNetworkVariableData = networkVariableData,
234234
ObserverIds = hasObserverIdList ? observerIds : null,
235235
NetworkObjectId = networkObject.NetworkObjectId,

com.unity.netcode.gameobjects/Runtime/Messaging/Messages/ParentSyncMessage.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ internal struct ParentSyncMessage : INetworkMessage
3838

3939
public void Serialize(FastBufferWriter writer, int targetVersion)
4040
{
41-
4241
byte bitset = 0x00;
4342
if (WorldPositionStays) { bitset |= k_WorldPositionStays; }
4443
if (IsLatestParentSet) { bitset |= k_IsLatestParentSet; }

com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3034,23 +3034,23 @@ internal struct DeferredObjectCreation
30343034
// When we transfer session owner and we are using a DAHost, this will be pertinent (otherwise it is not when connected to a DA service)
30353035
internal ulong[] ObserverIds;
30363036
internal ulong[] NewObserverIds;
3037-
internal NetworkObject.NetworkObjectSynchronizer NetworkObjectSynchronizer;
3037+
internal NetworkObject.SerializedObject SerializedObject;
30383038
internal FastBufferReader FastBufferReader;
30393039
}
30403040

30413041
internal List<DeferredObjectCreation> DeferredObjectCreationList = new List<DeferredObjectCreation>();
30423042
internal int DeferredObjectCreationCount;
30433043

30443044
// The added clientIds is specific to DAHost when session ownership changes and a normal client is controlling scene loading
3045-
internal void DeferCreateObject(ulong senderId, uint messageSize, NetworkObject.NetworkObjectSynchronizer networkObjectSynchronizer, FastBufferReader fastBufferReader, ulong[] observerIds, ulong[] newObserverIds)
3045+
internal void DeferCreateObject(ulong senderId, uint messageSize, NetworkObject.SerializedObject serializedObject, FastBufferReader fastBufferReader, ulong[] observerIds, ulong[] newObserverIds)
30463046
{
30473047
var deferredObjectCreationEntry = new DeferredObjectCreation()
30483048
{
30493049
SenderId = senderId,
30503050
MessageSize = messageSize,
30513051
ObserverIds = observerIds,
30523052
NewObserverIds = newObserverIds,
3053-
NetworkObjectSynchronizer = networkObjectSynchronizer,
3053+
SerializedObject = serializedObject,
30543054
};
30553055

30563056
unsafe

0 commit comments

Comments
 (0)