Vixen
dd8b0a81
csharp
public interface ISyncList

A list a behaviour replicates, as the replicator sees it.

Read the guide page for this →

Remarks

Non-generic, because a behaviour's lists are of different element types and the thing that writes them does not care which — it writes bits. SyncList`1 is the only implementation, and the interface exists so that one replicator handles a behaviour's whole collection rather than one per element type.

Fields and properties (3)

  • string Name

    What it is called, for diagnostics and for the bandwidth report.

  • int Count

    How many are in it.

  • bool HasPending

    Whether there is anything to send.

Methods (4)

  • void Rename(string name)

    Gives it the name its declaration chose.

  • bool WriteWhole(ref BitWriter writer)

    Writes the whole list.

  • bool Apply(ref BitReader reader)

    Takes a list as it arrived.

  • void ClearPending()

    Marks whatever was outstanding as dealt with.

Used by (4)

  • NetworkBehaviourVixen.Net.Engine
  • SyncListVixen.Net.Engine
  • SyncListReplicatorVixen.Net.Engine
  • SyncStateSweepSystemVixen.Net.Engine