Search Results for

    Show / Hide Table of Contents

    Class NetworkReader

    Network Reader for most simple types like floats, ints, buffers, structs, etc. Use NetworkReaderPool.GetReader() to avoid allocations.

    Inheritance
    Object
    NetworkReader
    NetworkReaderPooled
    Namespace: Mirror
    Assembly: doc.dll
    Syntax
    public class NetworkReader : object

    Constructors

    | Improve this Doc View Source

    NetworkReader(ArraySegment<Byte>)

    Declaration
    public NetworkReader(ArraySegment<byte> segment)
    Parameters
    Type Name Description
    ArraySegment<Byte> segment
    | Improve this Doc View Source

    NetworkReader(Byte[])

    Declaration
    public NetworkReader(byte[] bytes)
    Parameters
    Type Name Description
    Byte[] bytes

    Fields

    | Improve this Doc View Source

    Position

    Next position to read from the buffer

    Declaration
    public int Position
    Field Value
    Type Description
    Int32

    Properties

    | Improve this Doc View Source

    Length

    Total number of bytes to read from buffer

    Declaration
    public int Length { get; }
    Property Value
    Type Description
    Int32
    | Improve this Doc View Source

    Remaining

    Remaining bytes that can be read, for convenience.

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

    Methods

    | Improve this Doc View Source

    Read<T>()

    Reads any data type that mirror supports. Uses weaver populated Reader(T).read

    Declaration
    public T Read<T>()
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T
    | Improve this Doc View Source

    ReadByte()

    Declaration
    public byte ReadByte()
    Returns
    Type Description
    Byte
    | Improve this Doc View Source

    ReadBytes(Byte[], Int32)

    Read 'count' bytes into the bytes array

    Declaration
    public byte[] ReadBytes(byte[] bytes, int count)
    Parameters
    Type Name Description
    Byte[] bytes
    Int32 count
    Returns
    Type Description
    Byte[]
    | Improve this Doc View Source

    ReadBytesSegment(Int32)

    Read 'count' bytes allocation-free as ArraySegment that points to the internal array.

    Declaration
    public ArraySegment<byte> ReadBytesSegment(int count)
    Parameters
    Type Name Description
    Int32 count
    Returns
    Type Description
    ArraySegment<Byte>
    | Improve this Doc View Source

    SetBuffer(ArraySegment<Byte>)

    Declaration
    public void SetBuffer(ArraySegment<byte> segment)
    Parameters
    Type Name Description
    ArraySegment<Byte> segment
    | Improve this Doc View Source

    SetBuffer(Byte[])

    Declaration
    public void SetBuffer(byte[] bytes)
    Parameters
    Type Name Description
    Byte[] bytes
    | Improve this Doc View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    Extension Methods

    NetworkReaderExtensions.ReadByte(NetworkReader)
    NetworkReaderExtensions.ReadByteNullable(NetworkReader)
    NetworkReaderExtensions.ReadSByte(NetworkReader)
    NetworkReaderExtensions.ReadSByteNullable(NetworkReader)
    NetworkReaderExtensions.ReadChar(NetworkReader)
    NetworkReaderExtensions.ReadCharNullable(NetworkReader)
    NetworkReaderExtensions.ReadBool(NetworkReader)
    NetworkReaderExtensions.ReadBoolNullable(NetworkReader)
    NetworkReaderExtensions.ReadShort(NetworkReader)
    NetworkReaderExtensions.ReadShortNullable(NetworkReader)
    NetworkReaderExtensions.ReadUShort(NetworkReader)
    NetworkReaderExtensions.ReadUShortNullable(NetworkReader)
    NetworkReaderExtensions.ReadInt(NetworkReader)
    NetworkReaderExtensions.ReadIntNullable(NetworkReader)
    NetworkReaderExtensions.ReadUInt(NetworkReader)
    NetworkReaderExtensions.ReadUIntNullable(NetworkReader)
    NetworkReaderExtensions.ReadLong(NetworkReader)
    NetworkReaderExtensions.ReadLongNullable(NetworkReader)
    NetworkReaderExtensions.ReadULong(NetworkReader)
    NetworkReaderExtensions.ReadULongNullable(NetworkReader)
    NetworkReaderExtensions.ReadFloat(NetworkReader)
    NetworkReaderExtensions.ReadFloatNullable(NetworkReader)
    NetworkReaderExtensions.ReadDouble(NetworkReader)
    NetworkReaderExtensions.ReadDoubleNullable(NetworkReader)
    NetworkReaderExtensions.ReadDecimal(NetworkReader)
    NetworkReaderExtensions.ReadDecimalNullable(NetworkReader)
    NetworkReaderExtensions.ReadString(NetworkReader)
    NetworkReaderExtensions.ReadBytesAndSize(NetworkReader)
    NetworkReaderExtensions.ReadBytes(NetworkReader, Int32)
    NetworkReaderExtensions.ReadBytesAndSizeSegment(NetworkReader)
    NetworkReaderExtensions.ReadVector2(NetworkReader)
    NetworkReaderExtensions.ReadVector2Nullable(NetworkReader)
    NetworkReaderExtensions.ReadVector3(NetworkReader)
    NetworkReaderExtensions.ReadVector3Nullable(NetworkReader)
    NetworkReaderExtensions.ReadVector4(NetworkReader)
    NetworkReaderExtensions.ReadVector4Nullable(NetworkReader)
    NetworkReaderExtensions.ReadVector2Int(NetworkReader)
    NetworkReaderExtensions.ReadVector2IntNullable(NetworkReader)
    NetworkReaderExtensions.ReadVector3Int(NetworkReader)
    NetworkReaderExtensions.ReadVector3IntNullable(NetworkReader)
    NetworkReaderExtensions.ReadColor(NetworkReader)
    NetworkReaderExtensions.ReadColorNullable(NetworkReader)
    NetworkReaderExtensions.ReadColor32(NetworkReader)
    NetworkReaderExtensions.ReadColor32Nullable(NetworkReader)
    NetworkReaderExtensions.ReadQuaternion(NetworkReader)
    NetworkReaderExtensions.ReadQuaternionNullable(NetworkReader)
    NetworkReaderExtensions.ReadRect(NetworkReader)
    NetworkReaderExtensions.ReadRectNullable(NetworkReader)
    NetworkReaderExtensions.ReadPlane(NetworkReader)
    NetworkReaderExtensions.ReadPlaneNullable(NetworkReader)
    NetworkReaderExtensions.ReadRay(NetworkReader)
    NetworkReaderExtensions.ReadRayNullable(NetworkReader)
    NetworkReaderExtensions.ReadMatrix4x4(NetworkReader)
    NetworkReaderExtensions.ReadMatrix4x4Nullable(NetworkReader)
    NetworkReaderExtensions.ReadGuid(NetworkReader)
    NetworkReaderExtensions.ReadGuidNullable(NetworkReader)
    NetworkReaderExtensions.ReadNetworkIdentity(NetworkReader)
    NetworkReaderExtensions.ReadNetworkBehaviour(NetworkReader)
    NetworkReaderExtensions.ReadNetworkBehaviour<T>(NetworkReader)
    NetworkReaderExtensions.ReadNetworkBehaviourSyncVar(NetworkReader)
    NetworkReaderExtensions.ReadTransform(NetworkReader)
    NetworkReaderExtensions.ReadGameObject(NetworkReader)
    NetworkReaderExtensions.ReadList<T>(NetworkReader)
    NetworkReaderExtensions.ReadArray<T>(NetworkReader)
    NetworkReaderExtensions.ReadUri(NetworkReader)
    NetworkReaderExtensions.ReadTexture2D(NetworkReader)
    NetworkReaderExtensions.ReadSprite(NetworkReader)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX