Class NetworkVariableSerialization<T>

Support methods for reading/writing NetworkVariables Because there are multiple overloads of WriteValue/ReadValue based on different generic constraints, but there's no way to achieve the same thing with a class, this sets up various read/write schemes based on which constraints are met by T using reflection, which is done at module load time.

Inheritance

object

NetworkVariableSerialization<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Netcode

Assembly: Unity.Netcode.Runtime.dll

Syntax

[Serializable]
public static class NetworkVariableSerialization<T>

Type Parameters

Name	Description
T	The type the associated NetworkVariable is templated on

Properties

AreEqual

Uses the most efficient mechanism for a given type to determine if two values are equal. For types that implement IEquatable<T>, it will call the Equals() method. For unmanaged types, it will do a bytewise memory comparison. For other types, it will call the == operator.

Note: If you are using this in a custom generic class, please make sure your class is decorated with GenerateSerializationForGenericParameterAttribute so that codegen can initialize the serialization mechanisms correctly. If your class is NOT generic, it is better to check their equality yourself.

Declaration

public static NetworkVariableSerialization<T>.EqualsDelegate AreEqual { get; }

Property Value

Type	Description
NetworkVariableSerialization<T>.EqualsDelegate

Methods

Duplicate(in T, ref T)

Duplicates a value using the most efficient means of creating a complete copy. For most types this is a simple assignment or memcpy. For managed types, this is will serialize and then deserialize the value to ensure a correct copy.

Note: If you are using this in a custom generic class, please make sure your class is decorated with GenerateSerializationForGenericParameterAttribute so that codegen can initialize the serialization mechanisms correctly. If your class is NOT generic, it is better to duplicate it directly.

If the codegen is unable to determine a serializer for a type, UserNetworkVariableSerialization<T>.DuplicateValue is called, which, by default, will throw an exception, unless you have assigned a user duplication callback to it at runtime.

Declaration

public static void Duplicate(in T value, ref T duplicatedValue)

Parameters

Type	Name	Description
T	value
T	duplicatedValue

Read(FastBufferReader, ref T)

Deserialize a value using the best-known serialization method for a generic value. Will reliably deserialize any value that is passed to it correctly with no boxing. For types whose deserialization can be determined by codegen (which is most types), GC will only be incurred if the type is a managed type and the ref value passed in is null, in which case a new value is created; otherwise, it will be deserialized in-place.

Note: If you are using this in a custom generic class, please make sure your class is decorated with GenerateSerializationForGenericParameterAttribute so that codegen can initialize the serialization mechanisms correctly. If your class is NOT generic, it is better to use FastBufferReader directly.

If the codegen is unable to determine a serializer for a type, UserNetworkVariableSerialization<T>.ReadValue is called, which, by default, will throw an exception, unless you have assigned a user deserialization callback to it at runtime.

Declaration

public static void Read(FastBufferReader reader, ref T value)

Parameters

Type	Name	Description
FastBufferReader	reader
T	value

ReadDelta(FastBufferReader, ref T)

Deserialize a value using the best-known serialization method for a generic value. Will reliably deserialize any value that is passed to it correctly with no boxing. For types whose deserialization can be determined by codegen (which is most types), GC will only be incurred if the type is a managed type and the ref value passed in is null, in which case a new value is created; otherwise, it will be deserialized in-place.

Note: If you are using this in a custom generic class, please make sure your class is decorated with GenerateSerializationForGenericParameterAttribute so that codegen can initialize the serialization mechanisms correctly. If your class is NOT generic, it is better to use FastBufferReader directly.

If the codegen is unable to determine a serializer for a type, UserNetworkVariableSerialization<T>.ReadValue is called, which, by default, will throw an exception, unless you have assigned a user deserialization callback to it at runtime.

Declaration

public static void ReadDelta(FastBufferReader reader, ref T value)

Parameters

Type	Name	Description
FastBufferReader	reader
T	value

Write(FastBufferWriter, ref T)

Serialize a value using the best-known serialization method for a generic value. Will reliably serialize any value that is passed to it correctly with no boxing.

Note: If you are using this in a custom generic class, please make sure your class is decorated with GenerateSerializationForGenericParameterAttribute so that codegen can initialize the serialization mechanisms correctly. If your class is NOT generic, it is better to use FastBufferWriter directly.

If the codegen is unable to determine a serializer for a type, UserNetworkVariableSerialization<T>.WriteValue is called, which, by default, will throw an exception, unless you have assigned a user serialization callback to it at runtime.

Declaration

public static void Write(FastBufferWriter writer, ref T value)

Parameters

Type	Name	Description
FastBufferWriter	writer
T	value

WriteDelta(FastBufferWriter, ref T, ref T)

Serialize a value using the best-known serialization method for a generic value. Will reliably serialize any value that is passed to it correctly with no boxing.

Note: If you are using this in a custom generic class, please make sure your class is decorated with GenerateSerializationForGenericParameterAttribute so that codegen can initialize the serialization mechanisms correctly. If your class is NOT generic, it is better to use FastBufferWriter directly.

If the codegen is unable to determine a serializer for a type, UserNetworkVariableSerialization<T>.WriteValue is called, which, by default, will throw an exception, unless you have assigned a user serialization callback to it at runtime.

Declaration

public static void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)

Parameters

Type	Name	Description
FastBufferWriter	writer
T	value
T	previousValue