diff --git a/Assets/Mirror/Runtime/SyncObject.cs b/Assets/Mirror/Runtime/SyncObject.cs index 5730a7453..c7bf105f9 100644 --- a/Assets/Mirror/Runtime/SyncObject.cs +++ b/Assets/Mirror/Runtime/SyncObject.cs @@ -1,26 +1,44 @@ namespace Mirror { - // A sync object is an object that can synchronize it's state - // between server and client, such as a SyncList + /// + /// A sync object is an object that can synchronize it's state + /// between server and client, such as a SyncList + /// public interface SyncObject { - // true if there are changes since the last flush + /// + /// true if there are changes since the last flush + /// bool IsDirty { get; } - // Discard all the queued changes - // Consider the object fully synchronized with clients + /// + /// Discard all the queued changes + /// Consider the object fully synchronized with clients + /// void Flush(); - // Write a full copy of the object + /// + /// Write a full copy of the object + /// + /// void OnSerializeAll(NetworkWriter writer); - // Write the changes made to the object + /// + /// Write the changes made to the object since last sync + /// + /// void OnSerializeDelta(NetworkWriter writer); - // deserialize all the data in the object + /// + /// Reads a full copy of the object + /// + /// void OnDeserializeAll(NetworkReader reader); - // deserialize changes since last sync + /// + /// Reads the changes made to the object since last sync + /// + /// void OnDeserializeDelta(NetworkReader reader); ///