Class ByteUnpacker
Byte Unpacking Helper Class Use this class to unpack values during deserialization for values that were packed. BytePacker to pack unpacked values
Namespace: Unity.Netcode
Syntax
public static class ByteUnpackerMethods
ReadValueBitPacked(FastBufferReader, out Int16)
Read a bit-packed 14-bit signed short from the stream. See BytePacker.cs for a description of the format.
Declaration
public static void ReadValueBitPacked(FastBufferReader reader, out short value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Int16 | value | The value to read |
ReadValueBitPacked(FastBufferReader, out Int32)
Read a bit-packed 29-bit signed int from the stream. See BytePacker.cs for a description of the format.
Declaration
public static void ReadValueBitPacked(FastBufferReader reader, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Int32 | value | The value to read |
ReadValueBitPacked(FastBufferReader, out Int64)
Read a bit-packed 60-bit signed long from the stream. See BytePacker.cs for a description of the format.
Declaration
public static void ReadValueBitPacked(FastBufferReader reader, out long value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Int64 | value | The value to read |
ReadValueBitPacked(FastBufferReader, out UInt16)
Read a bit-packed 15-bit unsigned short from the stream. See BytePacker.cs for a description of the format.
Declaration
public static void ReadValueBitPacked(FastBufferReader reader, out ushort value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| UInt16 | value | The value to read |
ReadValueBitPacked(FastBufferReader, out UInt32)
Read a bit-packed 30-bit unsigned int from the stream. See BytePacker.cs for a description of the format.
Declaration
public static void ReadValueBitPacked(FastBufferReader reader, out uint value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| UInt32 | value | The value to read |
ReadValueBitPacked(FastBufferReader, out UInt64)
Read a bit-packed 61-bit signed long from the stream. See BytePacker.cs for a description of the format.
Declaration
public static void ReadValueBitPacked(FastBufferReader reader, out ulong value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| UInt64 | value | The value to read |
ReadValuePacked(FastBufferReader, out Boolean)
Read a boolean from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out bool value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Boolean | value | Value to read |
ReadValuePacked(FastBufferReader, out Byte)
Read a byte from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out byte value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Byte | value | Value to read |
ReadValuePacked(FastBufferReader, out Char)
Read a two-byte character as a varint from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out char c)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Char | c | Value to read |
ReadValuePacked(FastBufferReader, out Double)
Read double-precision floating point value from the stream as a varint
Declaration
public static void ReadValuePacked(FastBufferReader reader, out double value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Double | value | Value to read |
ReadValuePacked(FastBufferReader, out Int16)
Read an usigned short (Int16) as a varint from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out short value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Int16 | value | Value to read |
ReadValuePacked(FastBufferReader, out Int32)
Read a signed int (Int32) as a ZigZag encoded varint from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out int value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Int32 | value | Value to read |
ReadValuePacked(FastBufferReader, out Int64)
Read a signed long (Int64) as a ZigZag encoded varint from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out long value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Int64 | value | Value to read |
ReadValuePacked(FastBufferReader, out SByte)
Read a signed byte from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out sbyte value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| SByte | value | Value to read |
ReadValuePacked(FastBufferReader, out Single)
Read single-precision floating point value from the stream as a varint
Declaration
public static void ReadValuePacked(FastBufferReader reader, out float value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Single | value | Value to read |
ReadValuePacked(FastBufferReader, out String)
Reads a string in a packed format
Declaration
public static void ReadValuePacked(FastBufferReader reader, out string s)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| String | s |
ReadValuePacked(FastBufferReader, out UInt16)
Read an unsigned short (UInt16) as a varint from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out ushort value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| UInt16 | value | Value to read |
ReadValuePacked(FastBufferReader, out UInt32)
Read an unsigned int (UInt32) from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out uint value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| UInt32 | value | Value to read |
ReadValuePacked(FastBufferReader, out UInt64)
Read an unsigned long (UInt64) from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out ulong value)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| UInt64 | value | Value to read |
ReadValuePacked(FastBufferReader, out Color)
Convenience method that reads four varint floats from the color from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Color color)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Color | color | Color to read |
ReadValuePacked(FastBufferReader, out Color32)
Convenience method that reads four varint floats from the color from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Color32 color)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Color32 | color | Color to read |
ReadValuePacked(FastBufferReader, out Quaternion)
Reads the rotation from the stream.
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Quaternion rotation)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Quaternion | rotation | Rotation to read |
ReadValuePacked(FastBufferReader, out Ray)
Convenience method that reads two packed Vector3 from the ray from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Ray ray)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Ray | ray | Ray to read |
ReadValuePacked(FastBufferReader, out Ray2D)
Convenience method that reads two packed Vector2 from the ray from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Ray2D ray2d)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Ray2D | ray2d | Ray2D to read |
ReadValuePacked(FastBufferReader, out Vector2)
Convenience method that reads two varint floats from the vector from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Vector2 vector2)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Vector2 | vector2 | Vector to read |
ReadValuePacked(FastBufferReader, out Vector3)
Convenience method that reads three varint floats from the vector from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Vector3 vector3)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Vector3 | vector3 | Vector to read |
ReadValuePacked(FastBufferReader, out Vector4)
Convenience method that reads four varint floats from the vector from the stream
Declaration
public static void ReadValuePacked(FastBufferReader reader, out Vector4 vector4)Parameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| Vector4 | vector4 | Vector to read |
ReadValuePacked<TEnum>(FastBufferReader, out TEnum)
Read a packed enum value
Declaration
public static void ReadValuePacked<TEnum>(FastBufferReader reader, out TEnum value)
where TEnum : struct, EnumParameters
| Type | Name | Description |
|---|---|---|
| FastBufferReader | reader | The reader to read from |
| TEnum | value | The value that's read |
Type Parameters
| Name | Description |
|---|---|
| TEnum | Type of enum to read |
Exceptions
| Type | Condition |
|---|---|
| InvalidOperationException | Throws InvalidOperationException if an enum somehow ends up not being the size of a byte, short, int, or long (which should be impossible) |