Interface SyncObject

SyncObjects sync state between server and client. E.g. SyncLists.

Namespace: Mirror
Assembly: doc.dll
Syntax
public interface SyncObject

Properties

| Improve this Doc View Source

IsRecording

Used internally to check if we are currently tracking changes.

Declaration
Func<bool> IsRecording { get; set; }
Property Value
Type Description
Func<Boolean>
| Improve this Doc View Source

OnDirty

Used internally to set owner NetworkBehaviour's dirty mask bit when changed.

Declaration
Action OnDirty { get; set; }
Property Value
Type Description
Action

Methods

| Improve this Doc View Source

ClearChanges()

Discard all the queued changes

Declaration
void ClearChanges()
| Improve this Doc View Source

Flush()

Declaration
void Flush()
| Improve this Doc View Source

OnDeserializeAll(NetworkReader)

Reads a full copy of the object

Declaration
void OnDeserializeAll(NetworkReader reader)
Parameters
Type Name Description
NetworkReader reader
| Improve this Doc View Source

OnDeserializeDelta(NetworkReader)

Reads the changes made to the object since last sync

Declaration
void OnDeserializeDelta(NetworkReader reader)
Parameters
Type Name Description
NetworkReader reader
| Improve this Doc View Source

OnSerializeAll(NetworkWriter)

Write a full copy of the object

Declaration
void OnSerializeAll(NetworkWriter writer)
Parameters
Type Name Description
NetworkWriter writer
| Improve this Doc View Source

OnSerializeDelta(NetworkWriter)

Write the changes made to the object since last sync

Declaration
void OnSerializeDelta(NetworkWriter writer)
Parameters
Type Name Description
NetworkWriter writer
| Improve this Doc View Source

Reset()

Resets the SyncObject so that it can be re-used

Declaration
void Reset()