Class SyncList<T>
- Namespace
- LiteEntitySystem.Extensions
- Assembly
- LiteEntitySystem.dll
public class SyncList<T> : SyncableFieldCustomRollback, ICollection<T>, IReadOnlyList<T>, IReadOnlyCollection<T>, IEnumerable<T>, IEnumerable where T : unmanaged
Type Parameters
T
- Inheritance
-
objectSyncList<T>
- Implements
-
ICollection<T>IEnumerable<T>
- Inherited Members
Constructors
SyncList()
public SyncList()
SyncList(int)
public SyncList(int capacity)
Parameters
capacity
int
Properties
Count
Gets the number of elements contained in the ICollection<T>.
public int Count { get; }
Property Value
- int
The number of elements contained in the ICollection<T>.
IsReadOnly
Gets a value indicating whether the ICollection<T> is read-only.
public bool IsReadOnly { get; }
Property Value
- bool
true if the ICollection<T> is read-only; otherwise, false.
this[int]
Gets the element at the specified index in the read-only list.
public T this[int index] { get; set; }
Parameters
index
intThe zero-based index of the element to get.
Property Value
- T
The element at the specified index in the read-only list.
Methods
Add(T)
Adds an item to the ICollection<T>.
public void Add(T item)
Parameters
item
TThe object to add to the ICollection<T>.
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
AfterReadRPC()
protected override void AfterReadRPC()
BeforeReadRPC()
protected override void BeforeReadRPC()
Clear()
Removes all items from the ICollection<T>.
public void Clear()
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
Contains(T)
Determines whether the ICollection<T> contains a specific value.
public bool Contains(T item)
Parameters
item
TThe object to locate in the ICollection<T>.
Returns
- bool
true if
item
is found in the ICollection<T>; otherwise, false.
CopyTo(T[], int)
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
public void CopyTo(T[] array, int arrayIndex)
Parameters
array
T[]The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.
arrayIndex
intThe zero-based index in
array
at which copying begins.
Exceptions
- ArgumentNullException
array
is null.- ArgumentOutOfRangeException
arrayIndex
is less than 0.- ArgumentException
The number of elements in the source ICollection<T> is greater than the available space from
arrayIndex
to the end of the destinationarray
.
GetEnumerator()
public SyncList<T>.SyncListEnumerator GetEnumerator()
Returns
IndexOf(T)
public int IndexOf(T item)
Parameters
item
T
Returns
OnRollback()
protected override void OnRollback()
OnSyncRequested()
Method for executing RPCs containing initial sync data that need to be sent after entity creation to existing players or when new player connected
protected override void OnSyncRequested()
RegisterRPC(ref SyncableRPCRegistrator)
protected override void RegisterRPC(ref SyncableRPCRegistrator r)
Parameters
Remove(T)
Removes the first occurrence of a specific object from the ICollection<T>.
public bool Remove(T item)
Parameters
item
TThe object to remove from the ICollection<T>.
Returns
- bool
true if
item
was successfully removed from the ICollection<T>; otherwise, false. This method also returns false ifitem
is not found in the original ICollection<T>.
Exceptions
- NotSupportedException
The ICollection<T> is read-only.
RemoveAt(int)
public void RemoveAt(int index)
Parameters
index
int
ToArray()
public T[] ToArray()
Returns
- T[]