-
Notifications
You must be signed in to change notification settings - Fork 460
Expand file tree
/
Copy pathSceneEventData.cs
More file actions
1413 lines (1276 loc) · 60.9 KB
/
SceneEventData.cs
File metadata and controls
1413 lines (1276 loc) · 60.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Unity.Collections;
using UnityEngine.SceneManagement;
namespace Unity.Netcode
{
/// <summary>
/// The different types of scene events communicated between a server and client. <br/>
/// Used by <see cref="NetworkSceneManager"/> for <see cref="SceneEventMessage"/> messages.<br/>
/// <em>Note: This is only when <see cref="NetworkConfig.EnableSceneManagement"/> is enabled.</em><br/>
/// See also: <br/>
/// <see cref="SceneEvent"/>
/// </summary>
public enum SceneEventType : byte
{
/// <summary>
/// Load a scene<br/>
/// <b>Invocation:</b> Server Side<br/>
/// <b>Message Flow:</b> Server to client<br/>
/// <b>Event Notification:</b> Both server and client are notified a load scene event started
/// </summary>
Load,
/// <summary>
/// Unload a scene<br/>
/// <b>Invocation:</b> Server Side<br/>
/// <b>Message Flow:</b> Server to client<br/>
/// <b>Event Notification:</b> Both server and client are notified an unload scene event started.
/// </summary>
Unload,
/// <summary>
/// Synchronizes current game session state for newly approved clients<br/>
/// <b>Invocation:</b> Server Side<br/>
/// <b>Message Flow:</b> Server to client<br/>
/// <b>Event Notification:</b> Server and Client receives a local notification (<em>server receives the ClientId being synchronized</em>).
/// </summary>
Synchronize,
/// <summary>
/// Game session re-synchronization of NetworkObjects that were destroyed during a <see cref="Synchronize"/> event<br/>
/// <b>Invocation:</b> Server Side<br/>
/// <b>Message Flow:</b> Server to client<br/>
/// <b>Event Notification:</b> Both server and client receive a local notification<br/>
/// </summary>
ReSynchronize,
/// <summary>
/// All clients have finished loading a scene<br/>
/// <b>Invocation:</b> Server Side<br/>
/// <b>Message Flow:</b> Server to Client<br/>
/// <b>Event Notification:</b> Both server and client receive a local notification containing the clients that finished
/// as well as the clients that timed out(<em>if any</em>).
/// </summary>
LoadEventCompleted,
/// <summary>
/// All clients have unloaded a scene<br/>
/// <b>Invocation:</b> Server Side<br/>
/// <b>Message Flow:</b> Server to Client<br/>
/// <b>Event Notification:</b> Both server and client receive a local notification containing the clients that finished
/// as well as the clients that timed out(<em>if any</em>).
/// </summary>
UnloadEventCompleted,
/// <summary>
/// A client has finished loading a scene<br/>
/// <b>Invocation:</b> Client Side<br/>
/// <b>Message Flow:</b> Client to Server<br/>
/// <b>Event Notification:</b> Both server and client receive a local notification.
/// </summary>
LoadComplete,
/// <summary>
/// A client has finished unloading a scene<br/>
/// <b>Invocation:</b> Client Side<br/>
/// <b>Message Flow:</b> Client to Server<br/>
/// <b>Event Notification:</b> Both server and client receive a local notification.
/// </summary>
UnloadComplete,
/// <summary>
/// A client has finished synchronizing from a <see cref="Synchronize"/> event<br/>
/// <b>Invocation:</b> Client Side<br/>
/// <b>Message Flow:</b> Client to Server<br/>
/// <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>
/// Used by <see cref="NetworkSceneManager"/> for <see cref="SceneEventMessage"/> messages
/// <em>Note: This is only when <see cref="NetworkConfig.EnableSceneManagement"/> is enabled.</em><br/>
/// See also: <seealso cref="SceneEvent"/>
/// </summary>
internal class SceneEventData : IDisposable
{
internal SceneEventType SceneEventType;
internal LoadSceneMode LoadSceneMode;
internal ForceNetworkSerializeByMemcpy<Guid> SceneEventProgressId;
internal uint SceneEventId;
internal uint ActiveSceneHash;
internal uint SceneHash;
internal NetworkSceneHandle SceneHandle;
// Used by the client during synchronization
internal uint ClientSceneHash;
internal NetworkSceneHandle NetworkSceneHandle;
/// Only used for <see cref="SceneEventType.Synchronize"/> scene events, this assures permissions when writing
/// NetworkVariable information. If that process changes, then we need to update this
/// In distributed authority mode this is used to route messages to the appropriate destination client
internal ulong TargetClientId;
/// Only used with a DAHost
internal ulong SenderClientId;
private Dictionary<uint, List<NetworkObject>> m_SceneNetworkObjects;
private Dictionary<uint, long> m_SceneNetworkObjectDataOffsets;
/// <summary>
/// Client or Server Side:
/// Client side: Generates a list of all NetworkObjects by their NetworkObjectId that was spawned during th synchronization process
/// Server side: Compares list from client to make sure client didn't drop a message about a NetworkObject being despawned while it
/// was synchronizing (if so server will send another message back to the client informing the client of NetworkObjects to remove)
/// spawned during an initial synchronization.
/// </summary>
private List<NetworkObject> m_NetworkObjectsSync = new List<NetworkObject>();
private List<NetworkObject> m_DespawnedInSceneObjectsSync = new List<NetworkObject>();
private Dictionary<int, List<uint>> m_DespawnedInSceneObjects = new Dictionary<int, List<uint>>();
/// <summary>
/// Server Side Re-Synchronization:
/// If there happens to be NetworkObjects in the final Event_Sync_Complete message that are no longer spawned,
/// the server will compile a list and send back an Event_ReSync message to the client.
/// </summary>
private List<ulong> m_NetworkObjectsToBeRemoved = new List<ulong>();
private bool m_HasInternalBuffer;
internal FastBufferReader InternalBuffer;
private NetworkManager m_NetworkManager;
internal List<ulong> ClientsCompleted;
internal List<ulong> ClientsTimedOut;
internal Queue<uint> ScenesToSynchronize;
internal Queue<NetworkSceneHandle> SceneHandlesToSynchronize;
internal LoadSceneMode ClientSynchronizationMode;
/// <summary>
/// Server Side:
/// Add a scene and its handle to the list of scenes the client should load before synchronizing
/// Since scene handles are not the same per instance, the client builds a server scene handle to
/// client scene handle lookup table.
/// Why include the scene handle? In order to support loading of the same additive scene more than once
/// we must distinguish which scene we are talking about when the server tells the client to unload a scene.
/// The server will always communicate its local relative scene's handle and the client will determine its
/// local relative handle from the table being built.
/// Look for <see cref="NetworkSceneManager.m_ServerSceneHandleToClientSceneHandle"/> usage to see where
/// entries are being added to or removed from the table
/// </summary>
/// <param name="sceneIndex"></param>
/// <param name="sceneHandle"></param>
internal void AddSceneToSynchronize(uint sceneHash, NetworkSceneHandle sceneHandle)
{
ScenesToSynchronize.Enqueue(sceneHash);
SceneHandlesToSynchronize.Enqueue(sceneHandle);
}
/// <summary>
/// Client Side:
/// Gets the next scene hash to be loaded for approval and/or late joining
/// </summary>
/// <returns></returns>
internal uint GetNextSceneSynchronizationHash()
{
return ScenesToSynchronize.Dequeue();
}
/// <summary>
/// Client Side:
/// Gets the next scene handle to be loaded for approval and/or late joining
/// </summary>
/// <returns></returns>
internal NetworkSceneHandle GetNextSceneSynchronizationHandle()
{
return SceneHandlesToSynchronize.Dequeue();
}
/// <summary>
/// Client Side:
/// Determines if all scenes have been processed during the synchronization process
/// </summary>
/// <returns>true/false</returns>
internal bool IsDoneWithSynchronization()
{
if (ScenesToSynchronize.Count == 0 && SceneHandlesToSynchronize.Count == 0)
{
return true;
}
else if (ScenesToSynchronize.Count != SceneHandlesToSynchronize.Count)
{
// This should never happen, but in the event it does...
throw new Exception($"[{nameof(SceneEventData)}-Internal Mismatch Error] {nameof(ScenesToSynchronize)} count != {nameof(SceneHandlesToSynchronize)} count!");
}
return false;
}
/// <summary>
/// Server Side:
/// Called just before the synchronization process
/// </summary>
internal void InitializeForSynch()
{
if (m_SceneNetworkObjects == null)
{
m_SceneNetworkObjects = new Dictionary<uint, List<NetworkObject>>();
}
else
{
m_SceneNetworkObjects.Clear();
}
if (ScenesToSynchronize == null)
{
ScenesToSynchronize = new Queue<uint>();
}
else
{
ScenesToSynchronize.Clear();
}
if (SceneHandlesToSynchronize == null)
{
SceneHandlesToSynchronize = new Queue<NetworkSceneHandle>();
}
else
{
SceneHandlesToSynchronize.Clear();
}
ForwardSynchronization = false;
}
/// <summary>
/// Used with SortParentedNetworkObjects to sort the children of the root parent NetworkObject
/// </summary>
/// <param name="first">object to be sorted</param>
/// <param name="second">object to be compared to for sorting the first object</param>
/// <returns></returns>
private int SortChildrenNetworkObjects(NetworkObject first, NetworkObject second)
{
var firstParent = first.GetCachedParent()?.GetComponent<NetworkObject>();
// If the second is the first's parent then move the first down
if (firstParent != null && firstParent == second)
{
return 1;
}
var secondParent = second.GetCachedParent()?.GetComponent<NetworkObject>();
// If the first is the second's parent then move the first up
if (secondParent != null && secondParent == first)
{
return -1;
}
// Otherwise, don't move the first at all
return 0;
}
/// <summary>
/// Sorts the synchronization order of the NetworkObjects to be serialized
/// by parents before children order
/// </summary>
private void SortParentedNetworkObjects()
{
var networkObjectList = m_NetworkObjectsSync.ToList();
foreach (var networkObject in networkObjectList)
{
// Find only the root parent NetworkObjects
if (networkObject.transform.childCount > 0 && networkObject.transform.parent == null)
{
// Get all child NetworkObjects of the root
var childNetworkObjects = networkObject.GetComponentsInChildren<NetworkObject>().ToList();
childNetworkObjects.Sort(SortChildrenNetworkObjects);
// Remove the root from the children list
childNetworkObjects.Remove(networkObject);
// Remove the root's children from the primary list
foreach (var childObject in childNetworkObjects)
{
m_NetworkObjectsSync.Remove(childObject);
}
// Insert or Add the sorted children list
var nextIndex = m_NetworkObjectsSync.IndexOf(networkObject) + 1;
if (nextIndex == m_NetworkObjectsSync.Count)
{
m_NetworkObjectsSync.AddRange(childNetworkObjects);
}
else
{
m_NetworkObjectsSync.InsertRange(nextIndex, childNetworkObjects);
}
}
}
}
internal static bool LogSerializationOrder = false;
internal void AddSpawnedNetworkObjects()
{
m_NetworkObjectsSync.Clear();
// If distributed authority mode and sending to the service, then ignore observers
var distributedAuthoritySendingToService = m_NetworkManager.DistributedAuthorityMode && TargetClientId == NetworkManager.ServerClientId;
foreach (var sobj in m_NetworkManager.SpawnManager.SpawnedObjectsList)
{
var spawnedObject = sobj;
// Don't synchronize objects that have pending visibility as that will be sent as a CreateObjectMessage towards the end of the current frame
if (TargetClientId != NetworkManager.ServerClientId && m_NetworkManager.SpawnManager.IsObjectVisibilityPending(TargetClientId, ref spawnedObject))
{
continue;
}
if (sobj.Observers.Contains(TargetClientId) || distributedAuthoritySendingToService)
{
m_NetworkObjectsSync.Add(sobj);
}
}
SortObjectsToSync();
}
/// <summary>
/// Used to order the object serialization for both synchronization and scene loading
/// </summary>
private void SortObjectsToSync()
{
// Sort by INetworkPrefabInstanceHandler implementation before the
// NetworkObjects spawned by the implementation
m_NetworkObjectsSync.Sort(SortNetworkObjects);
// The last thing we sort is parents before children
SortParentedNetworkObjects();
// This is useful to know what NetworkObjects a client is going to be synchronized with
// as well as the order in which they will be deserialized
if (LogSerializationOrder && m_NetworkManager.LogLevel == LogLevel.Developer)
{
var messageBuilder = new StringBuilder(0xFFFF);
messageBuilder.AppendLine("[Server-Side Client-Synchronization] NetworkObject serialization order:");
foreach (var networkObject in m_NetworkObjectsSync)
{
messageBuilder.AppendLine($"{networkObject.name}");
}
NetworkLog.LogInfo(messageBuilder.ToString());
}
}
internal void AddDespawnedInSceneNetworkObjects()
{
m_DespawnedInSceneObjectsSync.Clear();
// Find all active and non-active in-scene placed NetworkObjects
var inSceneNetworkObjects = FindObjects.FindObjectsByType<NetworkObject>().Where((c) => c.NetworkManager == m_NetworkManager);
foreach (var sobj in inSceneNetworkObjects)
{
if (sobj.IsSceneObject.HasValue && sobj.IsSceneObject.Value && !sobj.IsSpawned)
{
sobj.NetworkManagerOwner = m_NetworkManager;
m_DespawnedInSceneObjectsSync.Add(sobj);
}
}
}
/// <summary>
/// Server Side:
/// Used during the synchronization process to associate NetworkObjects with scenes
/// </summary>
/// <param name="sceneIndex"></param>
/// <param name="networkObject"></param>
internal void AddNetworkObjectForSynch(uint sceneIndex, NetworkObject networkObject)
{
if (!m_SceneNetworkObjects.ContainsKey(sceneIndex))
{
m_SceneNetworkObjects.Add(sceneIndex, new List<NetworkObject>());
}
m_SceneNetworkObjects[sceneIndex].Add(networkObject);
}
/// <summary>
/// Client and Server:
/// Determines if the scene event type was intended for the client ( or server )
/// </summary>
/// <returns>true (client should handle this message) false (server should handle this message)</returns>
internal bool IsSceneEventClientSide()
{
switch (SceneEventType)
{
case SceneEventType.Load:
case SceneEventType.Unload:
case SceneEventType.Synchronize:
case SceneEventType.ReSynchronize:
case SceneEventType.LoadEventCompleted:
case SceneEventType.UnloadEventCompleted:
case SceneEventType.ActiveSceneChanged:
case SceneEventType.ObjectSceneChanged:
{
return true;
}
}
return false;
}
/// <summary>
/// Server Side:
/// Sorts the NetworkObjects to assure proper instantiation order of operations for
/// registered INetworkPrefabInstanceHandler implementations
/// </summary>
/// <param name="first"></param>
/// <param name="second"></param>
/// <returns></returns>
private int SortNetworkObjects(NetworkObject first, NetworkObject second)
{
var doesFirstHaveHandler = m_NetworkManager.PrefabHandler.ContainsHandler(first);
var doesSecondHaveHandler = m_NetworkManager.PrefabHandler.ContainsHandler(second);
if (doesFirstHaveHandler != doesSecondHaveHandler)
{
if (doesFirstHaveHandler)
{
return 1;
}
else
{
return -1;
}
}
return 0;
}
internal bool EnableSerializationLogs = false;
private void LogArray(byte[] data, int start = 0, int stop = 0, StringBuilder builder = null)
{
var usingExternalBuilder = builder != null;
if (!usingExternalBuilder)
{
builder = new StringBuilder();
}
if (stop == 0)
{
stop = data.Length;
}
builder.AppendLine($"[Start Data Dump][Start = {start}][Stop = {stop}] Size ({stop - start})");
for (int i = start; i < stop; i++)
{
builder.Append($"{data[i]:X2} ");
}
builder.Append("\n");
if (!usingExternalBuilder)
{
UnityEngine.Debug.Log(builder.ToString());
}
}
internal bool ForwardSynchronization;
/// <summary>
/// Client and Server Side:
/// Serializes data based on the SceneEvent type (<see cref="SceneEventType"/>)
/// </summary>
/// <param name="writer"><see cref="FastBufferWriter"/> to write the scene event data</param>
internal void Serialize(FastBufferWriter writer)
{
// Write the scene event type
writer.WriteValueSafe(SceneEventType);
if (m_NetworkManager.DistributedAuthorityMode)
{
BytePacker.WriteValueBitPacked(writer, TargetClientId);
BytePacker.WriteValueBitPacked(writer, SenderClientId);
}
if (SceneEventType == SceneEventType.ActiveSceneChanged)
{
writer.WriteValueSafe(ActiveSceneHash);
return;
}
if (SceneEventType == SceneEventType.ObjectSceneChanged)
{
SerializeObjectsMovedIntoNewScene(writer);
return;
}
// Write the scene loading mode
writer.WriteValueSafe((byte)LoadSceneMode);
// Write the scene event progress Guid
if (SceneEventType != SceneEventType.Synchronize)
{
writer.WriteValueSafe(SceneEventProgressId);
}
else
{
writer.WriteValueSafe(ClientSynchronizationMode);
}
// Write the scene index and handle
writer.WriteValueSafe(SceneHash);
writer.WriteValueSafe(SceneHandle);
switch (SceneEventType)
{
case SceneEventType.Synchronize:
{
writer.WriteValueSafe(ActiveSceneHash);
WriteSceneSynchronizationData(writer);
if (EnableSerializationLogs)
{
LogArray(writer.ToArray(), 0, writer.Length);
}
break;
}
case SceneEventType.Load:
{
if (m_NetworkManager.DistributedAuthorityMode && IsForwarding && m_NetworkManager.DAHost)
{
CopyInternalBuffer(ref writer);
}
else
{
SerializeScenePlacedObjects(writer);
}
break;
}
case SceneEventType.SynchronizeComplete:
{
WriteClientSynchronizationResults(writer);
break;
}
case SceneEventType.ReSynchronize:
{
WriteClientReSynchronizationData(writer);
break;
}
case SceneEventType.LoadEventCompleted:
case SceneEventType.UnloadEventCompleted:
{
WriteSceneEventProgressDone(writer);
break;
}
}
}
private unsafe void CopyInternalBuffer(ref FastBufferWriter writer)
{
writer.WriteBytesSafe(InternalBuffer.GetUnsafePtrAtCurrentPosition(), InternalBuffer.Length);
}
/// <summary>
/// Server Side:
/// Called at the end of a <see cref="SceneEventType.Load"/> event once the scene is loaded and scene placed NetworkObjects
/// have been locally spawned
/// </summary>
internal void WriteSceneSynchronizationData(FastBufferWriter writer)
{
var builder = (StringBuilder)null;
if (EnableSerializationLogs)
{
builder = new StringBuilder();
builder.AppendLine($"[Write][Synchronize-Start][WPos: {writer.Position}] Begin:");
}
// Write the scenes we want to load, in the order we want to load them
writer.WriteValueSafe(ScenesToSynchronize.ToArray());
writer.WriteValueSafe(SceneHandlesToSynchronize.ToArray());
// Store our current position in the stream to come back and say how much data we have written
var positionStart = writer.Position;
if (m_NetworkManager.DistributedAuthorityMode && ForwardSynchronization && m_NetworkManager.DAHost)
{
writer.WriteValueSafe(m_InternalBufferSize);
CopyInternalBuffer(ref writer);
if (EnableSerializationLogs)
{
LogArray(writer.ToArray(), positionStart);
}
return;
}
// 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(0);
int totalBytes = 0;
// Write the number of NetworkObjects we are serializing
writer.WriteValueSafe(m_NetworkObjectsSync.Count);
if (EnableSerializationLogs)
{
builder.AppendLine($"[Synchronize Objects][positionStart: {positionStart}][WPos: {writer.Position}][NO-Count: {m_NetworkObjectsSync.Count}] Begin:");
}
var distributedAuthority = m_NetworkManager.DistributedAuthorityMode;
// Serialize all NetworkObjects that are spawned
for (var i = 0; i < m_NetworkObjectsSync.Count; ++i)
{
var networkObject = m_NetworkObjectsSync[i];
var noStart = writer.Position;
// In distributed authority mode, we send the currently known observers of each NetworkObject to the client being synchronized.
var serializedObject = m_NetworkObjectsSync[i].Serialize(TargetClientId, distributedAuthority);
serializedObject.Serialize(writer);
var noStop = writer.Position;
totalBytes += noStop - noStart;
if (EnableSerializationLogs)
{
var offStart = noStart - (positionStart + sizeof(int));
var offStop = noStop - (positionStart + sizeof(int));
builder.AppendLine($"[Head: {offStart}][Tail: {offStop}][Size: {offStop - offStart}][{networkObject.name}][NID-{networkObject.NetworkObjectId}][Children: {networkObject.ChildNetworkBehaviours.Count}]");
LogArray(writer.ToArray(), noStart, noStop, builder);
}
}
if (EnableSerializationLogs)
{
UnityEngine.Debug.Log(builder.ToString());
}
// Write the number of despawned in-scene placed NetworkObjects
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync.Count);
// Write the scene handle and GlobalObjectIdHash value
for (var i = 0; i < m_DespawnedInSceneObjectsSync.Count; ++i)
{
var noStart = writer.Position;
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync[i].GetSceneOriginHandle());
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync[i].GlobalObjectIdHash);
var noStop = writer.Position;
totalBytes += noStop - noStart;
}
// Size Place Holder -- End
var positionEnd = writer.Position;
var bytesWritten = (uint)(positionEnd - (positionStart + sizeof(uint)));
writer.Seek(positionStart);
// Write the total size written to the stream by NetworkObjects being serialized
writer.WriteValueSafe(bytesWritten);
writer.Seek(positionEnd);
if (EnableSerializationLogs)
{
LogArray(writer.ToArray(), positionStart);
}
}
/// <summary>
/// Server Side:
/// Called at the end of a <see cref="SceneEventType.Load"/> event once the scene is loaded and scene placed NetworkObjects
/// have been locally spawned
/// Maximum number of objects that could theoretically be synchronized is 65536
/// </summary>
internal void SerializeScenePlacedObjects(FastBufferWriter writer)
{
var numberOfObjects = (ushort)0;
var headPosition = writer.Position;
// Write our count place holder (must not be packed!)
writer.WriteValueSafe((ushort)0);
var distributedAuthority = m_NetworkManager.DistributedAuthorityMode;
// If distributed authority mode and sending to the service, then ignore observers
var distributedAuthoritySendingToService = distributedAuthority && TargetClientId == NetworkManager.ServerClientId;
// Clear our objects to sync and build a list of the in-scene placed NetworkObjects instantiated and spawned locally
m_NetworkObjectsSync.Clear();
foreach (var keyValuePairByGlobalObjectIdHash in m_NetworkManager.SceneManager.ScenePlacedObjects)
{
foreach (var keyValuePairBySceneHandle in keyValuePairByGlobalObjectIdHash.Value)
{
if (keyValuePairBySceneHandle.Value.Observers.Contains(TargetClientId) || distributedAuthoritySendingToService)
{
m_NetworkObjectsSync.Add(keyValuePairBySceneHandle.Value);
}
}
}
// Sort the objects to sync based on parenting hierarchy
SortObjectsToSync();
// Serialize the sorted objects to sync.
foreach (var objectToSycn in m_NetworkObjectsSync)
{
// Serialize the NetworkObject
var serializedObject = objectToSycn.Serialize(TargetClientId, distributedAuthority);
serializedObject.Serialize(writer);
numberOfObjects++;
}
// Write the number of despawned in-scene placed NetworkObjects
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync.Count);
// Write the scene handle and GlobalObjectIdHash value
for (var i = 0; i < m_DespawnedInSceneObjectsSync.Count; ++i)
{
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync[i].GetSceneOriginHandle());
writer.WriteValueSafe(m_DespawnedInSceneObjectsSync[i].GlobalObjectIdHash);
}
var tailPosition = writer.Position;
// Reposition to our count position to the head before we wrote our object count
writer.Seek(headPosition);
// Write number of NetworkObjects serialized (must not be packed!)
writer.WriteValueSafe(numberOfObjects);
// Set our position back to the tail
writer.Seek(tailPosition);
}
/// <summary>
/// Client and Server Side:
/// Deserialize data based on the SceneEvent type.
/// </summary>
/// <param name="reader"></param>
internal void Deserialize(FastBufferReader reader)
{
reader.ReadValueSafe(out SceneEventType);
if (m_NetworkManager.DistributedAuthorityMode)
{
ByteUnpacker.ReadValueBitPacked(reader, out TargetClientId);
ByteUnpacker.ReadValueBitPacked(reader, out SenderClientId);
}
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;
if (SceneEventType != SceneEventType.Synchronize)
{
reader.ReadValueSafe(out SceneEventProgressId);
}
else
{
reader.ReadValueSafe(out ClientSynchronizationMode);
}
reader.ReadValueSafe(out SceneHash);
reader.ReadValueSafe(out SceneHandle);
switch (SceneEventType)
{
case SceneEventType.Synchronize:
{
reader.ReadValueSafe(out ActiveSceneHash);
if (EnableSerializationLogs)
{
LogArray(reader.ToArray(), 0, reader.Length);
}
CopySceneSynchronizationData(reader);
break;
}
case SceneEventType.SynchronizeComplete:
{
CheckClientSynchronizationResults(reader);
break;
}
case SceneEventType.Load:
{
unsafe
{
// We store off the trailing in-scene placed serialized NetworkObject data to
// be processed once we are done loading.
m_HasInternalBuffer = true;
// We use Allocator.Persistent since scene loading could take longer than 4 frames
InternalBuffer = new FastBufferReader(reader.GetUnsafePtrAtCurrentPosition(), Allocator.Persistent, reader.Length - reader.Position);
}
break;
}
case SceneEventType.ReSynchronize:
{
ReadClientReSynchronizationData(reader);
break;
}
case SceneEventType.LoadEventCompleted:
case SceneEventType.UnloadEventCompleted:
{
ReadSceneEventProgressDone(reader);
break;
}
}
}
private int m_InternalBufferSize;
/// <summary>
/// Client Side:
/// Prepares for a scene synchronization event and copies the scene synchronization data
/// into the internal buffer to be used throughout the synchronization process.
/// </summary>
/// <param name="reader"></param>
internal void CopySceneSynchronizationData(FastBufferReader reader)
{
m_NetworkObjectsSync.Clear();
reader.ReadValueSafe(out uint[] scenesToSynchronize);
reader.ReadValueSafe(out NetworkSceneHandle[] sceneHandlesToSynchronize);
ScenesToSynchronize = new Queue<uint>(scenesToSynchronize);
SceneHandlesToSynchronize = new Queue<NetworkSceneHandle>(sceneHandlesToSynchronize);
// is not packed!
reader.ReadValueSafe(out int sizeToCopy);
m_InternalBufferSize = sizeToCopy;
unsafe
{
if (!reader.TryBeginRead(sizeToCopy))
{
throw new OverflowException("Not enough space in the buffer to read recorded synchronization data size.");
}
m_HasInternalBuffer = true;
// We use Allocator.Persistent since scene synchronization will most likely take longer than 4 frames
InternalBuffer = new FastBufferReader(reader.GetUnsafePtrAtCurrentPosition(), Allocator.Persistent, sizeToCopy);
if (EnableSerializationLogs)
{
LogArray(InternalBuffer.ToArray());
}
}
}
/// <summary>
/// Client Side:
/// This needs to occur at the end of a <see cref="SceneEventType.Load"/> event when the scene has finished loading
/// Maximum number of objects that could theoretically be synchronized is 65536
/// </summary>
internal void DeserializeScenePlacedObjects()
{
try
{
// is not packed!
InternalBuffer.ReadValueSafe(out ushort newObjectsCount);
var sceneObjects = new List<NetworkObject>();
for (ushort i = 0; i < newObjectsCount; i++)
{
var serializedObject = new NetworkObject.SerializedObject();
serializedObject.Deserialize(InternalBuffer);
if (serializedObject.IsSceneObject)
{
// Set our relative scene to the NetworkObject
m_NetworkManager.SceneManager.SetTheSceneBeingSynchronized(serializedObject.NetworkSceneHandle);
}
var networkObject = NetworkObject.Deserialize(serializedObject, InternalBuffer, m_NetworkManager);
if (serializedObject.IsSceneObject)
{
sceneObjects.Add(networkObject);
}
}
// Now deserialize the despawned in-scene placed NetworkObjects list (if any)
DeserializeDespawnedInScenePlacedNetworkObjects();
// Notify all newly spawned in-scene placed NetworkObjects that all in-scene placed
// NetworkObjects have been spawned.
foreach (var networkObject in sceneObjects)
{
networkObject.InternalInSceneNetworkObjectsSpawned();
}
}
finally
{
InternalBuffer.Dispose();
m_HasInternalBuffer = false;
}
}
/// <summary>
/// Client Side:
/// If there happens to be NetworkObjects in the final Event_Sync_Complete message that are no longer spawned,
/// the server will compile a list and send back an Event_ReSync message to the client. This is where the
/// client handles any returned values by the server.
/// </summary>
/// <param name="reader"></param>
internal void ReadClientReSynchronizationData(FastBufferReader reader)
{
reader.ReadValueSafe(out uint[] networkObjectsToRemove);
if (networkObjectsToRemove.Length > 0)
{
var networkObjects = FindObjects.FindObjectsByType<NetworkObject>();
var networkObjectIdToNetworkObject = new Dictionary<ulong, NetworkObject>();
foreach (var networkObject in networkObjects)
{
if (!networkObjectIdToNetworkObject.ContainsKey(networkObject.NetworkObjectId))
{
networkObjectIdToNetworkObject.Add(networkObject.NetworkObjectId, networkObject);
}
}
foreach (var networkObjectId in networkObjectsToRemove)
{
if (networkObjectIdToNetworkObject.ContainsKey(networkObjectId))
{
var networkObject = networkObjectIdToNetworkObject[networkObjectId];
networkObjectIdToNetworkObject.Remove(networkObjectId);
networkObject.IsSpawned = false;
if (m_NetworkManager.PrefabHandler.ContainsHandler(networkObject))
{
if (m_NetworkManager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId))
{
m_NetworkManager.SpawnManager.SpawnedObjects.Remove(networkObjectId);
}
if (m_NetworkManager.SpawnManager.SpawnedObjectsList.Contains(networkObject))
{
m_NetworkManager.SpawnManager.SpawnedObjectsList.Remove(networkObject);
}
NetworkManager.Singleton.PrefabHandler.HandleNetworkPrefabDestroy(networkObject);
}
else
{
UnityEngine.Object.DestroyImmediate(networkObject.gameObject);
}
}
}
}
}
/// <summary>
/// Server Side:
/// If there happens to be NetworkObjects in the final Event_Sync_Complete message that are no longer spawned,
/// the server will compile a list and send back an Event_ReSync message to the client.
/// </summary>
/// <param name="writer"></param>
internal void WriteClientReSynchronizationData(FastBufferWriter writer)
{
//Write how many objects need to be removed
writer.WriteValueSafe(m_NetworkObjectsToBeRemoved.ToArray());
}
/// <summary>
/// Server Side:
/// Determines if the client needs to be slightly re-synchronized if during the deserialization
/// process the server finds NetworkObjects that the client still thinks are spawned.
/// </summary>
/// <returns></returns>
internal bool ClientNeedsReSynchronization()
{
return (m_NetworkObjectsToBeRemoved.Count > 0);
}
/// <summary>
/// Server Side:
/// Determines if the client needs to be re-synchronized if during the deserialization
/// process the server finds NetworkObjects that the client still thinks are spawned but
/// have since been despawned.
/// </summary>
/// <param name="reader"></param>
internal void CheckClientSynchronizationResults(FastBufferReader reader)
{
m_NetworkObjectsToBeRemoved.Clear();
reader.ReadValueSafe(out uint networkObjectIdCount);
for (int i = 0; i < networkObjectIdCount; i++)
{
reader.ReadValueSafe(out uint networkObjectId);
if (!m_NetworkManager.SpawnManager.SpawnedObjects.ContainsKey(networkObjectId))
{
m_NetworkObjectsToBeRemoved.Add(networkObjectId);
}
}
}
/// <summary>
/// Client Side:
/// During the deserialization process of the servers Event_Sync, the client builds a list of