docs.unity3d.com
    Show / Hide Table of Contents

    Class NetworkList<T>

    Event based NetworkVariable container for syncing Lists

    Inheritance
    Object
    NetworkVariableBase
    NetworkList<T>
    Inherited Members
    NetworkVariableBase.GetBehaviour()
    NetworkVariableBase.Initialize(NetworkBehaviour)
    NetworkVariableBase.DefaultReadPerm
    NetworkVariableBase.DefaultWritePerm
    NetworkVariableBase.Name
    NetworkVariableBase.ReadPerm
    NetworkVariableBase.WritePerm
    NetworkVariableBase.SetDirty(Boolean)
    NetworkVariableBase.CanClientRead(UInt64)
    NetworkVariableBase.CanClientWrite(UInt64)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Unity.Netcode
    Syntax
    public class NetworkList<T> : NetworkVariableBase, IDisposable where T : struct, IEquatable<T>
    Type Parameters
    Name Description
    T

    The type for the list

    Constructors

    NetworkList()

    Constructor method for

    Declaration
    public NetworkList()

    NetworkList(IEnumerable<T>, NetworkVariableReadPermission, NetworkVariableWritePermission)

    Declaration
    public NetworkList(IEnumerable<T> values = null, NetworkVariableReadPermission readPerm = NetworkVariableReadPermission.Everyone, NetworkVariableWritePermission writePerm = NetworkVariableWritePermission.Server)
    Parameters
    Type Name Description
    IEnumerable<T> values
    NetworkVariableReadPermission readPerm
    NetworkVariableWritePermission writePerm

    Properties

    Count

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    Int32

    Item[Int32]

    Declaration
    public T this[int index] { get; set; }
    Parameters
    Type Name Description
    Int32 index
    Property Value
    Type Description
    T

    LastModifiedTick

    This is actually unused left-over from a previous interface

    Declaration
    public int LastModifiedTick { get; }
    Property Value
    Type Description
    Int32

    Methods

    Add(T)

    Declaration
    public void Add(T item)
    Parameters
    Type Name Description
    T item

    Clear()

    Declaration
    public void Clear()

    Contains(T)

    Declaration
    public bool Contains(T item)
    Parameters
    Type Name Description
    T item
    Returns
    Type Description
    Boolean

    Dispose()

    Overridden IDisposable implementation. CAUTION: If you derive from this class and override the Dispose() method, you must always invoke the base.Dispose() method!

    Declaration
    public override void Dispose()
    Overrides
    NetworkVariableBase.Dispose()

    GetEnumerator()

    Declaration
    public IEnumerator<T> GetEnumerator()
    Returns
    Type Description
    IEnumerator<T>

    IndexOf(T)

    Declaration
    public int IndexOf(T item)
    Parameters
    Type Name Description
    T item
    Returns
    Type Description
    Int32

    Insert(Int32, T)

    Declaration
    public void Insert(int index, T item)
    Parameters
    Type Name Description
    Int32 index
    T item

    IsDirty()

    Gets Whether or not the container is dirty

    Declaration
    public override bool IsDirty()
    Returns
    Type Description
    Boolean

    Whether or not the container is dirty

    Overrides
    NetworkVariableBase.IsDirty()

    ReadDelta(FastBufferReader, Boolean)

    Reads delta from the reader and applies them to the internal value

    Declaration
    public override void ReadDelta(FastBufferReader reader, bool keepDirtyDelta)
    Parameters
    Type Name Description
    FastBufferReader reader

    The stream to read the delta from

    Boolean keepDirtyDelta

    Whether or not the delta should be kept as dirty or consumed

    Overrides
    NetworkVariableBase.ReadDelta(FastBufferReader, Boolean)

    ReadField(FastBufferReader)

    Reads the complete state from the reader and applies it

    Declaration
    public override void ReadField(FastBufferReader reader)
    Parameters
    Type Name Description
    FastBufferReader reader

    The stream to read the state from

    Overrides
    NetworkVariableBase.ReadField(FastBufferReader)

    Remove(T)

    Declaration
    public bool Remove(T item)
    Parameters
    Type Name Description
    T item
    Returns
    Type Description
    Boolean

    RemoveAt(Int32)

    Declaration
    public void RemoveAt(int index)
    Parameters
    Type Name Description
    Int32 index

    ResetDirty()

    Resets the dirty state and marks the variable as synced / clean

    Declaration
    public override void ResetDirty()
    Overrides
    NetworkVariableBase.ResetDirty()

    WriteDelta(FastBufferWriter)

    Writes the dirty changes, that is, the changes since the variable was last dirty, to the writer

    Declaration
    public override void WriteDelta(FastBufferWriter writer)
    Parameters
    Type Name Description
    FastBufferWriter writer

    The stream to write the dirty changes to

    Overrides
    NetworkVariableBase.WriteDelta(FastBufferWriter)

    WriteField(FastBufferWriter)

    Writes the complete state of the variable to the writer

    Declaration
    public override void WriteField(FastBufferWriter writer)
    Parameters
    Type Name Description
    FastBufferWriter writer

    The stream to write the state to

    Overrides
    NetworkVariableBase.WriteField(FastBufferWriter)

    Events

    OnListChanged

    The callback to be invoked when the list gets changed

    Declaration
    public event NetworkList<T>.OnListChangedDelegate OnListChanged
    Event Type
    Type Description
    NetworkList.OnListChangedDelegate<>
    Back to top Copyright © 2023 Unity Technologies — Terms of use
    Generated by DocFX
    on 26 October 2023