Mirror.SyncSet< T > Class Template Reference

Inheritance diagram for Mirror.SyncSet< T >:

Public Member Functions
delegate void	SyncSetChanged (Operation op, T item)
	SyncSet (ISet< T > objects)
override void	Reset ()
	Resets the SyncObject so that it can be re-used More...
override void	ClearChanges ()
	Discard all the queued changes More...
override void	OnSerializeAll (NetworkWriter writer)
	Write a full copy of the object More...
override void	OnSerializeDelta (NetworkWriter writer)
	Write the changes made to the object since last sync More...
override void	OnDeserializeAll (NetworkReader reader)
	Reads a full copy of the object More...
override void	OnDeserializeDelta (NetworkReader reader)
	Reads the changes made to the object since last sync More...
bool	Add (T item)
void	Clear ()
bool	Contains (T item)
void	CopyTo (T[] array, int index)
bool	Remove (T item)
IEnumerator< T >	GetEnumerator ()
void	ExceptWith (IEnumerable< T > other)
void	IntersectWith (IEnumerable< T > other)
bool	IsProperSubsetOf (IEnumerable< T > other)
bool	IsProperSupersetOf (IEnumerable< T > other)
bool	IsSubsetOf (IEnumerable< T > other)
bool	IsSupersetOf (IEnumerable< T > other)
bool	Overlaps (IEnumerable< T > other)
bool	SetEquals (IEnumerable< T > other)
void	SymmetricExceptWith (IEnumerable< T > other)
void	UnionWith (IEnumerable< T > other)
abstract void	ClearChanges ()
	Discard all the queued changes More...
abstract void	OnSerializeAll (NetworkWriter writer)
	Write a full copy of the object More...
abstract void	OnSerializeDelta (NetworkWriter writer)
	Write the changes made to the object since last sync More...
abstract void	OnDeserializeAll (NetworkReader reader)
	Reads a full copy of the object More...
abstract void	OnDeserializeDelta (NetworkReader reader)
	Reads the changes made to the object since last sync More...
abstract void	Reset ()
	Resets the SyncObject so that it can be re-used More...

Protected Attributes
readonly ISet< T >	objects

Properties
int	Count [get]
bool	IsReadOnly [get]

Events
SyncSetChanged	Callback

Additional Inherited Members
Public Attributes inherited from Mirror.SyncObject
Action	OnDirty
	Used internally to set owner NetworkBehaviour's dirty mask bit when changed. More...
Func< bool >	IsRecording = () => true
	Used internally to check if we are currently tracking changes. More...

Detailed Description

Definition at line 7 of file SyncSet.cs.

Constructor & Destructor Documentation

SyncSet()

Mirror.SyncSet< T >.SyncSet

(

ISet< T >

objects

)

Definition at line 43 of file SyncSet.cs.

        {
            this.objects = objects;
        }

Member Function Documentation

Add()

bool Mirror.SyncSet< T >.Add

(

T

item

)

Definition at line 204 of file SyncSet.cs.

        {
            if (objects.Add(item))
            {
                AddOperation(Operation.OP_ADD, item);
                return true;
            }
            return false;
        }

Clear()

void Mirror.SyncSet< T >.Clear

(

)

Definition at line 222 of file SyncSet.cs.

        {
            objects.Clear();
            AddOperation(Operation.OP_CLEAR);
        }

ClearChanges()

override void Mirror.SyncSet< T >.ClearChanges ( )

virtual

Discard all the queued changes

Implements Mirror.SyncObject.

ExceptWith()

void Mirror.SyncSet< T >.ExceptWith

(

IEnumerable< T >

other

)

Definition at line 246 of file SyncSet.cs.

        {
            if (other == this)
            {
                Clear();
                return;
            }
 
            // remove every element in other from this
            foreach (T element in other)
            {
                Remove(element);
            }
        }

IntersectWith()

void Mirror.SyncSet< T >.IntersectWith

(

IEnumerable< T >

other

)

Definition at line 261 of file SyncSet.cs.

        {
            if (other is ISet<T> otherSet)
            {
                IntersectWithSet(otherSet);
            }
            else
            {
                HashSet<T> otherAsSet = new HashSet<T>(other);
                IntersectWithSet(otherAsSet);
            }
        }

OnDeserializeAll()

override void Mirror.SyncSet< T >.OnDeserializeAll ( NetworkReader  reader )

virtual

Reads a full copy of the object

Implements Mirror.SyncObject.

Definition at line 127 of file SyncSet.cs.

        {
            // This list can now only be modified by synchronization
            IsReadOnly = true;
 
            // if init,  write the full list content
            int count = (int)reader.ReadUInt();
 
            objects.Clear();
            changes.Clear();
 
            for (int i = 0; i < count; i++)
            {
                T obj = reader.Read<T>();
                objects.Add(obj);
            }
 
            // We will need to skip all these changes
            // the next time the list is synchronized
            // because they have already been applied
            changesAhead = (int)reader.ReadUInt();
        }

OnDeserializeDelta()

override void Mirror.SyncSet< T >.OnDeserializeDelta ( NetworkReader  reader )

virtual

Reads the changes made to the object since last sync

Implements Mirror.SyncObject.

Definition at line 150 of file SyncSet.cs.

        {
            // This list can now only be modified by synchronization
            IsReadOnly = true;
 
            int changesCount = (int)reader.ReadUInt();
 
            for (int i = 0; i < changesCount; i++)
            {
                Operation operation = (Operation)reader.ReadByte();
 
                // apply the operation only if it is a new change
                // that we have not applied yet
                bool apply = changesAhead == 0;
                T item = default;
 
                switch (operation)
                {
                    case Operation.OP_ADD:
                        item = reader.Read<T>();
                        if (apply)
                        {
                            objects.Add(item);
                        }
                        break;
 
                    case Operation.OP_CLEAR:
                        if (apply)
                        {
                            objects.Clear();
                        }
                        break;
 
                    case Operation.OP_REMOVE:
                        item = reader.Read<T>();
                        if (apply)
                        {
                            objects.Remove(item);
                        }
                        break;
                }
 
                if (apply)
                {
                    Callback?.Invoke(operation, item);
                }
                // we just skipped this change
                else
                {
                    changesAhead--;
                }
            }
        }

OnSerializeAll()

override void Mirror.SyncSet< T >.OnSerializeAll ( NetworkWriter  writer )

virtual

Write a full copy of the object

Implements Mirror.SyncObject.

Definition at line 84 of file SyncSet.cs.

        {
            // if init,  write the full list content
            writer.WriteUInt((uint)objects.Count);
 
            foreach (T obj in objects)
            {
                writer.Write(obj);
            }
 
            // all changes have been applied already
            // thus the client will need to skip all the pending changes
            // or they would be applied again.
            // So we write how many changes are pending
            writer.WriteUInt((uint)changes.Count);
        }

OnSerializeDelta()

override void Mirror.SyncSet< T >.OnSerializeDelta ( NetworkWriter  writer )

virtual

Write the changes made to the object since last sync

Implements Mirror.SyncObject.

Definition at line 101 of file SyncSet.cs.

        {
            // write all the queued up changes
            writer.WriteUInt((uint)changes.Count);
 
            for (int i = 0; i < changes.Count; i++)
            {
                Change change = changes[i];
                writer.WriteByte((byte)change.operation);
 
                switch (change.operation)
                {
                    case Operation.OP_ADD:
                        writer.Write(change.item);
                        break;
 
                    case Operation.OP_CLEAR:
                        break;
 
                    case Operation.OP_REMOVE:
                        writer.Write(change.item);
                        break;
                }
            }
        }

Remove()

bool Mirror.SyncSet< T >.Remove

(

T

item

)

Definition at line 232 of file SyncSet.cs.

        {
            if (objects.Remove(item))
            {
                AddOperation(Operation.OP_REMOVE, item);
                return true;
            }
            return false;
        }

Reset()

override void Mirror.SyncSet< T >.Reset ( )

virtual

Resets the SyncObject so that it can be re-used

Implements Mirror.SyncObject.

Definition at line 48 of file SyncSet.cs.

        {
            IsReadOnly = false;
            changes.Clear();
            changesAhead = 0;
            objects.Clear();
        }

SymmetricExceptWith()

void Mirror.SyncSet< T >.SymmetricExceptWith

(

IEnumerable< T >

other

)

Definition at line 300 of file SyncSet.cs.

        {
            if (other == this)
            {
                Clear();
            }
            else
            {
                foreach (T element in other)
                {
                    if (!Remove(element))
                    {
                        Add(element);
                    }
                }
            }
        }

UnionWith()

void Mirror.SyncSet< T >.UnionWith

(

IEnumerable< T >

other

)

Definition at line 319 of file SyncSet.cs.

        {
            if (other != this)
            {
                foreach (T element in other)
                {
                    Add(element);
                }
            }
        }

Member Data Documentation

objects

readonly ISet<T> Mirror.SyncSet< T >.objects

protected

Definition at line 11 of file SyncSet.cs.

Property Documentation

Count

int Mirror.SyncSet< T >.Count

get

Definition at line 13 of file SyncSet.cs.

IsReadOnly

bool Mirror.SyncSet< T >.IsReadOnly

get

Definition at line 14 of file SyncSet.cs.

{ get; private set; }

Event Documentation

Callback

SyncSetChanged Mirror.SyncSet< T >.Callback

Definition at line 15 of file SyncSet.cs.