Mirror.SyncList< T > Class Template Reference

Inheritance diagram for Mirror.SyncList< T >:

Classes
struct	Enumerator

Public Member Functions
delegate void	SyncListChanged (Operation op, int itemIndex, T oldItem, T newItem)
	SyncList (IEqualityComparer< T > comparer)
	SyncList (IList< T > objects, IEqualityComparer< T > comparer=null)
override void	ClearChanges ()
	Discard all the queued changes More...
override void	Reset ()
	Resets the SyncObject so that it can be re-used 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...
void	Add (T item)
void	AddRange (IEnumerable< T > range)
void	Clear ()
bool	Contains (T item)
void	CopyTo (T[] array, int index)
int	IndexOf (T item)
int	FindIndex (Predicate< T > match)
T	Find (Predicate< T > match)
List< T >	FindAll (Predicate< T > match)
void	Insert (int index, T item)
void	InsertRange (int index, IEnumerable< T > range)
bool	Remove (T item)
void	RemoveAt (int index)
int	RemoveAll (Predicate< T > match)
Enumerator	GetEnumerator ()
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...

Properties
int	Count [get]
bool	IsReadOnly [get]
T	this[int i] [get, set]

Events
SyncListChanged	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 SyncList.cs.

Constructor & Destructor Documentation

SyncList() [1/3]

Mirror.SyncList< T >.SyncList

(

)

Definition at line 46 of file SyncList.cs.

: this(EqualityComparer<T>.Default) {}

SyncList() [2/3]

Mirror.SyncList< T >.SyncList

(

IEqualityComparer< T >

comparer

)

Definition at line 48 of file SyncList.cs.

        {
            this.comparer = comparer ?? EqualityComparer<T>.Default;
            objects = new List<T>();
        }

SyncList() [3/3]

Mirror.SyncList< T >.SyncList	(	IList< T >	objects,
		IEqualityComparer< T >	comparer = null
	)

Definition at line 54 of file SyncList.cs.

        {
            this.comparer = comparer ?? EqualityComparer<T>.Default;
            this.objects = objects;
        }

Member Function Documentation

Add()

void Mirror.SyncList< T >.Add

(

T

item

)

Definition at line 245 of file SyncList.cs.

        {
            objects.Add(item);
            AddOperation(Operation.OP_ADD, objects.Count - 1, default, item);
        }

AddRange()

void Mirror.SyncList< T >.AddRange

(

IEnumerable< T >

range

)

Definition at line 251 of file SyncList.cs.

        {
            foreach (T entry in range)
            {
                Add(entry);
            }
        }

Clear()

void Mirror.SyncList< T >.Clear

(

)

Definition at line 259 of file SyncList.cs.

        {
            objects.Clear();
            AddOperation(Operation.OP_CLEAR, 0, default, default);
        }

ClearChanges()

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

virtual

Discard all the queued changes

Implements Mirror.SyncObject.

Find()

T Mirror.SyncList< T >.Find

(

Predicate< T >

match

)

Definition at line 285 of file SyncList.cs.

        {
            int i = FindIndex(match);
            return (i != -1) ? objects[i] : default;
        }

FindAll()

List< T > Mirror.SyncList< T >.FindAll

(

Predicate< T >

match

)

Definition at line 291 of file SyncList.cs.

        {
            List<T> results = new List<T>();
            for (int i = 0; i < objects.Count; ++i)
                if (match(objects[i]))
                    results.Add(objects[i]);
            return results;
        }

FindIndex()

int Mirror.SyncList< T >.FindIndex

(

Predicate< T >

match

)

Definition at line 277 of file SyncList.cs.

        {
            for (int i = 0; i < objects.Count; ++i)
                if (match(objects[i]))
                    return i;
            return -1;
        }

IndexOf()

int Mirror.SyncList< T >.IndexOf

(

T

item

)

Definition at line 269 of file SyncList.cs.

        {
            for (int i = 0; i < objects.Count; ++i)
                if (comparer.Equals(item, objects[i]))
                    return i;
            return -1;
        }

Insert()

void Mirror.SyncList< T >.Insert	(	int	index,
		T	item
	)

Definition at line 300 of file SyncList.cs.

        {
            objects.Insert(index, item);
            AddOperation(Operation.OP_INSERT, index, default, item);
        }

InsertRange()

void Mirror.SyncList< T >.InsertRange	(	int	index,
		IEnumerable< T >	range
	)

Definition at line 306 of file SyncList.cs.

        {
            foreach (T entry in range)
            {
                Insert(index, entry);
                index++;
            }
        }

OnDeserializeAll()

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

virtual

Reads a full copy of the object

Implements Mirror.SyncObject.

Definition at line 145 of file SyncList.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.SyncList< T >.OnDeserializeDelta ( NetworkReader  reader )

virtual

Reads the changes made to the object since last sync

Implements Mirror.SyncObject.

Definition at line 168 of file SyncList.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;
                int index = 0;
                T oldItem = default;
                T newItem = default;
 
                switch (operation)
                {
                    case Operation.OP_ADD:
                        newItem = reader.Read<T>();
                        if (apply)
                        {
                            index = objects.Count;
                            objects.Add(newItem);
                        }
                        break;
 
                    case Operation.OP_CLEAR:
                        if (apply)
                        {
                            objects.Clear();
                        }
                        break;
 
                    case Operation.OP_INSERT:
                        index = (int)reader.ReadUInt();
                        newItem = reader.Read<T>();
                        if (apply)
                        {
                            objects.Insert(index, newItem);
                        }
                        break;
 
                    case Operation.OP_REMOVEAT:
                        index = (int)reader.ReadUInt();
                        if (apply)
                        {
                            oldItem = objects[index];
                            objects.RemoveAt(index);
                        }
                        break;
 
                    case Operation.OP_SET:
                        index = (int)reader.ReadUInt();
                        newItem = reader.Read<T>();
                        if (apply)
                        {
                            oldItem = objects[index];
                            objects[index] = newItem;
                        }
                        break;
                }
 
                if (apply)
                {
                    Callback?.Invoke(operation, index, oldItem, newItem);
                }
                // we just skipped this change
                else
                {
                    changesAhead--;
                }
            }
        }

OnSerializeAll()

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

virtual

Write a full copy of the object

Implements Mirror.SyncObject.

Definition at line 95 of file SyncList.cs.

        {
            // if init,  write the full list content
            writer.WriteUInt((uint)objects.Count);
 
            for (int i = 0; i < objects.Count; i++)
            {
                T obj = objects[i];
                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.SyncList< T >.OnSerializeDelta ( NetworkWriter  writer )

virtual

Write the changes made to the object since last sync

Implements Mirror.SyncObject.

Definition at line 113 of file SyncList.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_REMOVEAT:
                        writer.WriteUInt((uint)change.index);
                        break;
 
                    case Operation.OP_INSERT:
                    case Operation.OP_SET:
                        writer.WriteUInt((uint)change.index);
                        writer.Write(change.item);
                        break;
                }
            }
        }

Remove()

bool Mirror.SyncList< T >.Remove

(

T

item

)

Definition at line 315 of file SyncList.cs.

        {
            int index = IndexOf(item);
            bool result = index >= 0;
            if (result)
            {
                RemoveAt(index);
            }
            return result;
        }

RemoveAll()

int Mirror.SyncList< T >.RemoveAll

(

Predicate< T >

match

)

Definition at line 333 of file SyncList.cs.

        {
            List<T> toRemove = new List<T>();
            for (int i = 0; i < objects.Count; ++i)
                if (match(objects[i]))
                    toRemove.Add(objects[i]);
 
            foreach (T entry in toRemove)
            {
                Remove(entry);
            }
 
            return toRemove.Count;
        }

RemoveAt()

void Mirror.SyncList< T >.RemoveAt

(

int

index

)

Definition at line 326 of file SyncList.cs.

        {
            T oldItem = objects[index];
            objects.RemoveAt(index);
            AddOperation(Operation.OP_REMOVEAT, index, oldItem, default);
        }

Reset()

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

virtual

Resets the SyncObject so that it can be re-used

Implements Mirror.SyncObject.

Definition at line 64 of file SyncList.cs.

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

Property Documentation

Count

int Mirror.SyncList< T >.Count

get

Definition at line 14 of file SyncList.cs.

IsReadOnly

bool Mirror.SyncList< T >.IsReadOnly

get

Definition at line 15 of file SyncList.cs.

{ get; private set; }

this[int i]

T Mirror.SyncList< T >.this[int i]

getset

Definition at line 348 of file SyncList.cs.

        {
            get => objects[i];
            set
            {
                if (!comparer.Equals(objects[i], value))
                {
                    T oldItem = objects[i];
                    objects[i] = value;
                    AddOperation(Operation.OP_SET, i, oldItem, value);
                }
            }
        }

Event Documentation

Callback

SyncListChanged Mirror.SyncList< T >.Callback

Definition at line 16 of file SyncList.cs.