charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 11:00:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

SyncObject cleanup

Browse Source
This commit is contained in:
vis2k 2021-03-10 17:25:26 +08:00
parent debcb400fe
commit 15d595fe41
1 changed files with 8 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
Assets/Mirror/Runtime/SyncObject.cs
View File

@ -6,44 +6,26 @@ namespace Mirror
/// </summary> /// </summary>
public interface SyncObject public interface SyncObject
{ {
/// <summary> /// <summary>True if there are changes since the last flush</summary>
/// true if there are changes since the last flush
/// </summary>
bool IsDirty { get; } bool IsDirty { get; }
/// <summary> /// <summary>Discard all the queued changes</summary>
/// Discard all the queued changes // Consider the object fully synchronized with clients
/// <para>Consider the object fully synchronized with clients</para>
/// </summary>
void Flush(); void Flush();
/// <summary> /// <summary>Write a full copy of the object</summary>
/// Write a full copy of the object
/// </summary>
/// <param name="writer"></param>
void OnSerializeAll(NetworkWriter writer); void OnSerializeAll(NetworkWriter writer);
/// <summary> /// <summary>Write the changes made to the object since last sync</summary>
/// Write the changes made to the object since last sync
/// </summary>
/// <param name="writer"></param>
void OnSerializeDelta(NetworkWriter writer); void OnSerializeDelta(NetworkWriter writer);
/// <summary> /// <summary>Reads a full copy of the object</summary>
/// Reads a full copy of the object
/// </summary>
/// <param name="reader"></param>
void OnDeserializeAll(NetworkReader reader); void OnDeserializeAll(NetworkReader reader);
/// <summary> /// <summary>Reads the changes made to the object since last sync</summary>
/// Reads the changes made to the object since last sync
/// </summary>
/// <param name="reader"></param>
void OnDeserializeDelta(NetworkReader reader); void OnDeserializeDelta(NetworkReader reader);
/// <summary> /// <summary>Resets the SyncObject so that it can be re-used</summary>
/// Resets the SyncObject so that it can be re-used
/// </summary>
void Reset(); void Reset();
} }
} }