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

Update SyncObject.cs

Browse Source
This commit is contained in:
James Frowen 2020-09-13 14:33:32 +01:00 committed by GitHub
parent 6411013253
commit d5c2387d1d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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
/// <summary>
/// A sync object is an object that can synchronize it's state
/// between server and client, such as a SyncList
/// </summary>
public interface SyncObject
{
// true if there are changes since the last flush
/// <summary>
/// true if there are changes since the last flush
/// </summary>
bool IsDirty { get; }
// Discard all the queued changes
// Consider the object fully synchronized with clients
/// <summary>
/// Discard all the queued changes
/// <para>Consider the object fully synchronized with clients</para>
/// </summary>
void Flush();
// Write a full copy of the object
/// <summary>
/// Write a full copy of the object
/// </summary>
/// <param name="writer"></param>
void OnSerializeAll(NetworkWriter writer);
// Write the changes made to the object
/// <summary>
/// Write the changes made to the object since last sync
/// </summary>
/// <param name="writer"></param>
void OnSerializeDelta(NetworkWriter writer);
// deserialize all the data in the object
/// <summary>
/// Reads a full copy of the object
/// </summary>
/// <param name="reader"></param>
void OnDeserializeAll(NetworkReader reader);
// deserialize changes since last sync
/// <summary>
/// Reads the changes made to the object since last sync
/// </summary>
/// <param name="reader"></param>
void OnDeserializeDelta(NetworkReader reader);
/// <summary>