The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). ## [1.9.1] - 2024-04-18 ### Added - Added AnticipatedNetworkVariable<T>, which adds support for client anticipation of NetworkVariable values, allowing for more responsive gameplay (#2820) - Added AnticipatedNetworkTransform, which adds support for client anticipation of NetworkTransforms (#2820) - Added NetworkVariableBase.ExceedsDirtinessThreshold to allow network variables to throttle updates by only sending updates when the difference between the current and previous values exceeds a threshold. (This is exposed in NetworkVariable<T> with the callback NetworkVariable<T>.CheckExceedsDirtinessThreshold) (#2820) - Added NetworkVariableUpdateTraits, which add additional throttling support: MinSecondsBetweenUpdates will prevent the NetworkVariable from sending updates more often than the specified time period (even if it exceeds the dirtiness threshold), while MaxSecondsBetweenUpdates will force a dirty NetworkVariable to send an update after the specified time period even if it has not yet exceeded the dirtiness threshold. (#2820) - Added virtual method NetworkVariableBase.OnInitialize() which can be used by NetworkVariable subclasses to add initialization code (#2820) - Added virtual method NetworkVariableBase.Update(), which is called once per frame to support behaviors such as interpolation between an anticipated value and an authoritative one. (#2820) - Added NetworkTime.TickWithPartial, which represents the current tick as a double that includes the fractional/partial tick value. (#2820) - Added NetworkTickSystem.AnticipationTick, which can be helpful with implementation of client anticipation. This value represents the tick the current local client was at at the beginning of the most recent network round trip, which enables it to correlate server update ticks with the client tick that may have triggered them. (#2820) - `NetworkVariable` now includes built-in support for `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, and `Dictionary` (#2813) - `NetworkVariable` now includes delta compression for collection values (`NativeList`, `NativeArray`, `NativeHashSet`, `NativeHashMap`, `List`, `HashSet`, `Dictionary`, and `FixedString` types) to save bandwidth by only sending the values that changed. (Note: For `NativeList`, `NativeArray`, and `List`, this algorithm works differently than that used in `NetworkList`. This algorithm will use less bandwidth for "set" and "add" operations, but `NetworkList` is more bandwidth-efficient if you are performing frequent "insert" operations.) (#2813) - `UserNetworkVariableSerialization` now has optional callbacks for `WriteDelta` and `ReadDelta`. If both are provided, they will be used for all serialization operations on NetworkVariables of that type except for the first one for each client. If either is missing, the existing `Write` and `Read` will always be used. (#2813) - Network variables wrapping `INetworkSerializable` types can perform delta serialization by setting `UserNetworkVariableSerialization<T>.WriteDelta` and `UserNetworkVariableSerialization<T>.ReadDelta` for those types. The built-in `INetworkSerializable` serializer will continue to be used for all other serialization operations, but if those callbacks are set, it will call into them on all but the initial serialization to perform delta serialization. (This could be useful if you have a large struct where most values do not change regularly and you want to send only the fields that did change.) (#2813) ### Fixed - Fixed issue where NetworkTransformEditor would throw and exception if you excluded the physics package. (#2871) - Fixed issue where `NetworkTransform` could not properly synchronize its base position when using half float precision. (#2845) - Fixed issue where the host was not invoking `OnClientDisconnectCallback` for its own local client when internally shutting down. (#2822) - Fixed issue where NetworkTransform could potentially attempt to "unregister" a named message prior to it being registered. (#2807) - Fixed issue where in-scene placed `NetworkObject`s with complex nested children `NetworkObject`s (more than one child in depth) would not synchronize properly if WorldPositionStays was set to true. (#2796) ### Changed - Changed `NetworkObjectReference` and `NetworkBehaviourReference` to allow null references when constructing and serializing. (#2874) - Changed `NetworkAnimator` no longer requires the `Animator` component to exist on the same `GameObject`. (#2872) - Changed `NetworkTransform` to now use `NetworkTransformMessage` as opposed to named messages for NetworkTransformState updates. (#2810) - Changed `CustomMessageManager` so it no longer attempts to register or "unregister" a null or empty string and will log an error if this condition occurs. (#2807)
2031 lines
80 KiB
C#
2031 lines
80 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using Unity.Collections;
|
|
using Unity.Collections.LowLevel.Unsafe;
|
|
using Unity.Mathematics;
|
|
using UnityEditor;
|
|
using UnityEngine;
|
|
|
|
namespace Unity.Netcode
|
|
{
|
|
/// <summary>
|
|
/// Interface used by NetworkVariables to serialize them
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal interface INetworkVariableSerializer<T>
|
|
{
|
|
// Write has to be taken by ref here because of INetworkSerializable
|
|
// Open Instance Delegates (pointers to methods without an instance attached to them)
|
|
// require the first parameter passed to them (the instance) to be passed by ref.
|
|
// So foo.Bar() becomes BarDelegate(ref foo);
|
|
// Taking T as an in parameter like we do in other places would require making a copy
|
|
// of it to pass it as a ref parameter.
|
|
public void Write(FastBufferWriter writer, ref T value);
|
|
public void Read(FastBufferReader reader, ref T value);
|
|
public void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue);
|
|
public void ReadDelta(FastBufferReader reader, ref T value);
|
|
internal void ReadWithAllocator(FastBufferReader reader, out T value, Allocator allocator);
|
|
public void Duplicate(in T value, ref T duplicatedValue);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packing serializer for shorts
|
|
/// </summary>
|
|
internal class ShortSerializer : INetworkVariableSerializer<short>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref short value)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref short value)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref short value, ref short previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref short value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<short>.ReadWithAllocator(FastBufferReader reader, out short value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in short value, ref short duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packing serializer for shorts
|
|
/// </summary>
|
|
internal class UshortSerializer : INetworkVariableSerializer<ushort>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref ushort value)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref ushort value)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref ushort value, ref ushort previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref ushort value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<ushort>.ReadWithAllocator(FastBufferReader reader, out ushort value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in ushort value, ref ushort duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packing serializer for ints
|
|
/// </summary>
|
|
internal class IntSerializer : INetworkVariableSerializer<int>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref int value)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref int value)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref int value, ref int previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref int value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<int>.ReadWithAllocator(FastBufferReader reader, out int value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in int value, ref int duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packing serializer for ints
|
|
/// </summary>
|
|
internal class UintSerializer : INetworkVariableSerializer<uint>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref uint value)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref uint value)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref uint value, ref uint previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref uint value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<uint>.ReadWithAllocator(FastBufferReader reader, out uint value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in uint value, ref uint duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packing serializer for longs
|
|
/// </summary>
|
|
internal class LongSerializer : INetworkVariableSerializer<long>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref long value)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref long value)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref long value, ref long previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref long value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<long>.ReadWithAllocator(FastBufferReader reader, out long value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in long value, ref long duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Packing serializer for longs
|
|
/// </summary>
|
|
internal class UlongSerializer : INetworkVariableSerializer<ulong>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref ulong value)
|
|
{
|
|
BytePacker.WriteValueBitPacked(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref ulong value)
|
|
{
|
|
ByteUnpacker.ReadValueBitPacked(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref ulong value, ref ulong previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref ulong value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<ulong>.ReadWithAllocator(FastBufferReader reader, out ulong value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in ulong value, ref ulong duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Basic serializer for unmanaged types.
|
|
/// This covers primitives, built-in unity types, and IForceSerializeByMemcpy
|
|
/// Since all of those ultimately end up calling WriteUnmanagedSafe, this simplifies things
|
|
/// by calling that directly - thus preventing us from having to have a specific T that meets
|
|
/// the specific constraints that the various generic WriteValue calls require.
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class UnmanagedTypeSerializer<T> : INetworkVariableSerializer<T> where T : unmanaged
|
|
{
|
|
public void Write(FastBufferWriter writer, ref T value)
|
|
{
|
|
writer.WriteUnmanagedSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref T value)
|
|
{
|
|
reader.ReadUnmanagedSafe(out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)
|
|
{
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref T value)
|
|
{
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<T>.ReadWithAllocator(FastBufferReader reader, out T value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in T value, ref T duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
internal class ListSerializer<T> : INetworkVariableSerializer<List<T>>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref List<T> value)
|
|
{
|
|
bool isNull = value == null;
|
|
writer.WriteValueSafe(isNull);
|
|
if (!isNull)
|
|
{
|
|
BytePacker.WriteValuePacked(writer, value.Count);
|
|
foreach (var item in value)
|
|
{
|
|
var reffable = item;
|
|
NetworkVariableSerialization<T>.Write(writer, ref reffable);
|
|
}
|
|
}
|
|
}
|
|
public void Read(FastBufferReader reader, ref List<T> value)
|
|
{
|
|
reader.ReadValueSafe(out bool isNull);
|
|
if (isNull)
|
|
{
|
|
value = null;
|
|
}
|
|
else
|
|
{
|
|
if (value == null)
|
|
{
|
|
value = new List<T>();
|
|
}
|
|
|
|
ByteUnpacker.ReadValuePacked(reader, out int len);
|
|
if (len < value.Count)
|
|
{
|
|
value.RemoveRange(len, value.Count - len);
|
|
}
|
|
for (var i = 0; i < len; ++i)
|
|
{
|
|
// Read in place where possible
|
|
if (i < value.Count)
|
|
{
|
|
T item = value[i];
|
|
NetworkVariableSerialization<T>.Read(reader, ref item);
|
|
value[i] = item;
|
|
}
|
|
else
|
|
{
|
|
T item = default;
|
|
NetworkVariableSerialization<T>.Read(reader, ref item);
|
|
value.Add(item);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref List<T> value, ref List<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteListDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref List<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadListDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<List<T>>.ReadWithAllocator(FastBufferReader reader, out List<T> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in List<T> value, ref List<T> duplicatedValue)
|
|
{
|
|
if (duplicatedValue == null)
|
|
{
|
|
duplicatedValue = new List<T>();
|
|
}
|
|
|
|
duplicatedValue.Clear();
|
|
foreach (var item in value)
|
|
{
|
|
duplicatedValue.Add(item);
|
|
}
|
|
}
|
|
}
|
|
|
|
internal class HashSetSerializer<T> : INetworkVariableSerializer<HashSet<T>> where T : IEquatable<T>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref HashSet<T> value)
|
|
{
|
|
bool isNull = value == null;
|
|
writer.WriteValueSafe(isNull);
|
|
if (!isNull)
|
|
{
|
|
writer.WriteValueSafe(value.Count);
|
|
foreach (var item in value)
|
|
{
|
|
var reffable = item;
|
|
NetworkVariableSerialization<T>.Write(writer, ref reffable);
|
|
}
|
|
}
|
|
}
|
|
public void Read(FastBufferReader reader, ref HashSet<T> value)
|
|
{
|
|
reader.ReadValueSafe(out bool isNull);
|
|
if (isNull)
|
|
{
|
|
value = null;
|
|
}
|
|
else
|
|
{
|
|
if (value == null)
|
|
{
|
|
value = new HashSet<T>();
|
|
}
|
|
else
|
|
{
|
|
value.Clear();
|
|
}
|
|
reader.ReadValueSafe(out int len);
|
|
for (var i = 0; i < len; ++i)
|
|
{
|
|
T item = default;
|
|
NetworkVariableSerialization<T>.Read(reader, ref item);
|
|
value.Add(item);
|
|
}
|
|
}
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref HashSet<T> value, ref HashSet<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteHashSetDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref HashSet<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadHashSetDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<HashSet<T>>.ReadWithAllocator(FastBufferReader reader, out HashSet<T> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in HashSet<T> value, ref HashSet<T> duplicatedValue)
|
|
{
|
|
if (duplicatedValue == null)
|
|
{
|
|
duplicatedValue = new HashSet<T>();
|
|
}
|
|
|
|
duplicatedValue.Clear();
|
|
foreach (var item in value)
|
|
{
|
|
duplicatedValue.Add(item);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
internal class DictionarySerializer<TKey, TVal> : INetworkVariableSerializer<Dictionary<TKey, TVal>>
|
|
where TKey : IEquatable<TKey>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref Dictionary<TKey, TVal> value)
|
|
{
|
|
bool isNull = value == null;
|
|
writer.WriteValueSafe(isNull);
|
|
if (!isNull)
|
|
{
|
|
writer.WriteValueSafe(value.Count);
|
|
foreach (var item in value)
|
|
{
|
|
(var key, var val) = (item.Key, item.Value);
|
|
NetworkVariableSerialization<TKey>.Write(writer, ref key);
|
|
NetworkVariableSerialization<TVal>.Write(writer, ref val);
|
|
}
|
|
}
|
|
}
|
|
public void Read(FastBufferReader reader, ref Dictionary<TKey, TVal> value)
|
|
{
|
|
reader.ReadValueSafe(out bool isNull);
|
|
if (isNull)
|
|
{
|
|
value = null;
|
|
}
|
|
else
|
|
{
|
|
if (value == null)
|
|
{
|
|
value = new Dictionary<TKey, TVal>();
|
|
}
|
|
else
|
|
{
|
|
value.Clear();
|
|
}
|
|
reader.ReadValueSafe(out int len);
|
|
for (var i = 0; i < len; ++i)
|
|
{
|
|
(TKey key, TVal val) = (default, default);
|
|
NetworkVariableSerialization<TKey>.Read(reader, ref key);
|
|
NetworkVariableSerialization<TVal>.Read(reader, ref val);
|
|
value.Add(key, val);
|
|
}
|
|
}
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref Dictionary<TKey, TVal> value, ref Dictionary<TKey, TVal> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteDictionaryDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref Dictionary<TKey, TVal> value)
|
|
{
|
|
CollectionSerializationUtility.ReadDictionaryDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<Dictionary<TKey, TVal>>.ReadWithAllocator(FastBufferReader reader, out Dictionary<TKey, TVal> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in Dictionary<TKey, TVal> value, ref Dictionary<TKey, TVal> duplicatedValue)
|
|
{
|
|
if (duplicatedValue == null)
|
|
{
|
|
duplicatedValue = new Dictionary<TKey, TVal>();
|
|
}
|
|
|
|
duplicatedValue.Clear();
|
|
foreach (var item in value)
|
|
{
|
|
duplicatedValue.Add(item.Key, item.Value);
|
|
}
|
|
}
|
|
}
|
|
|
|
internal class UnmanagedArraySerializer<T> : INetworkVariableSerializer<NativeArray<T>> where T : unmanaged
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeArray<T> value)
|
|
{
|
|
writer.WriteUnmanagedSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeArray<T> value)
|
|
{
|
|
value.Dispose();
|
|
reader.ReadUnmanagedSafe(out value, Allocator.Persistent);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeArray<T> value, ref NativeArray<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeArrayDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeArray<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeArrayDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeArray<T>>.ReadWithAllocator(FastBufferReader reader, out NativeArray<T> value, Allocator allocator)
|
|
{
|
|
reader.ReadUnmanagedSafe(out value, allocator);
|
|
}
|
|
|
|
public void Duplicate(in NativeArray<T> value, ref NativeArray<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated || duplicatedValue.Length != value.Length)
|
|
{
|
|
if (duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue.Dispose();
|
|
}
|
|
|
|
duplicatedValue = new NativeArray<T>(value.Length, Allocator.Persistent, NativeArrayOptions.UninitializedMemory);
|
|
}
|
|
|
|
duplicatedValue.CopyFrom(value);
|
|
}
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
internal class UnmanagedListSerializer<T> : INetworkVariableSerializer<NativeList<T>> where T : unmanaged
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeList<T> value)
|
|
{
|
|
writer.WriteUnmanagedSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeList<T> value)
|
|
{
|
|
reader.ReadUnmanagedSafeInPlace(ref value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeList<T> value, ref NativeList<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeListDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeList<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeListDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeList<T>>.ReadWithAllocator(FastBufferReader reader, out NativeList<T> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in NativeList<T> value, ref NativeList<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue = new NativeList<T>(value.Length, Allocator.Persistent);
|
|
}
|
|
else if (value.Length != duplicatedValue.Length)
|
|
{
|
|
duplicatedValue.ResizeUninitialized(value.Length);
|
|
}
|
|
|
|
duplicatedValue.CopyFrom(value);
|
|
}
|
|
}
|
|
|
|
|
|
internal class NativeHashSetSerializer<T> : INetworkVariableSerializer<NativeHashSet<T>> where T : unmanaged, IEquatable<T>
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeHashSet<T> value)
|
|
{
|
|
writer.WriteValueSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeHashSet<T> value)
|
|
{
|
|
reader.ReadValueSafeInPlace(ref value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeHashSet<T> value, ref NativeHashSet<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeHashSetDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeHashSet<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeHashSetDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeHashSet<T>>.ReadWithAllocator(FastBufferReader reader, out NativeHashSet<T> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in NativeHashSet<T> value, ref NativeHashSet<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue = new NativeHashSet<T>(value.Capacity, Allocator.Persistent);
|
|
}
|
|
|
|
duplicatedValue.Clear();
|
|
foreach (var item in value)
|
|
{
|
|
duplicatedValue.Add(item);
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
internal class NativeHashMapSerializer<TKey, TVal> : INetworkVariableSerializer<NativeHashMap<TKey, TVal>>
|
|
where TKey : unmanaged, IEquatable<TKey>
|
|
where TVal : unmanaged
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeHashMap<TKey, TVal> value)
|
|
{
|
|
writer.WriteValueSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeHashMap<TKey, TVal> value)
|
|
{
|
|
reader.ReadValueSafeInPlace(ref value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeHashMap<TKey, TVal> value, ref NativeHashMap<TKey, TVal> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeHashMapDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeHashMap<TKey, TVal> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeHashMapDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeHashMap<TKey, TVal>>.ReadWithAllocator(FastBufferReader reader, out NativeHashMap<TKey, TVal> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in NativeHashMap<TKey, TVal> value, ref NativeHashMap<TKey, TVal> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue = new NativeHashMap<TKey, TVal>(value.Capacity, Allocator.Persistent);
|
|
}
|
|
|
|
duplicatedValue.Clear();
|
|
foreach (var item in value)
|
|
{
|
|
duplicatedValue.Add(item.Key, item.Value);
|
|
}
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Serializer for FixedStrings
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class FixedStringSerializer<T> : INetworkVariableSerializer<T> where T : unmanaged, INativeList<byte>, IUTF8Bytes
|
|
{
|
|
public void Write(FastBufferWriter writer, ref T value)
|
|
{
|
|
writer.WriteValueSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref T value)
|
|
{
|
|
reader.ReadValueSafeInPlace(ref value);
|
|
}
|
|
|
|
// Because of how strings are generally used, it is likely that most strings will still write as full strings
|
|
// instead of deltas. This actually adds one byte to the data to encode that it was serialized in full.
|
|
// But the potential savings from a small change to a large string are valuable enough to be worth that extra
|
|
// byte.
|
|
public unsafe void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)
|
|
{
|
|
using var changes = new ResizableBitVector(Allocator.Temp);
|
|
int minLength = math.min(value.Length, previousValue.Length);
|
|
var numChanges = 0;
|
|
for (var i = 0; i < minLength; ++i)
|
|
{
|
|
var val = value[i];
|
|
var prevVal = previousValue[i];
|
|
if (!NetworkVariableSerialization<byte>.AreEqual(ref val, ref prevVal))
|
|
{
|
|
++numChanges;
|
|
changes.Set(i);
|
|
}
|
|
}
|
|
|
|
for (var i = previousValue.Length; i < value.Length; ++i)
|
|
{
|
|
++numChanges;
|
|
changes.Set(i);
|
|
}
|
|
|
|
if (changes.GetSerializedSize() + FastBufferWriter.GetWriteSize<byte>() * numChanges > FastBufferWriter.GetWriteSize<byte>() * value.Length)
|
|
{
|
|
writer.WriteByteSafe(1);
|
|
writer.WriteValueSafe(value);
|
|
return;
|
|
}
|
|
writer.WriteByte(0);
|
|
BytePacker.WriteValuePacked(writer, value.Length);
|
|
writer.WriteValueSafe(changes);
|
|
unsafe
|
|
{
|
|
byte* ptr = value.GetUnsafePtr();
|
|
byte* prevPtr = previousValue.GetUnsafePtr();
|
|
for (int i = 0; i < value.Length; ++i)
|
|
{
|
|
if (changes.IsSet(i))
|
|
{
|
|
if (i < previousValue.Length)
|
|
{
|
|
NetworkVariableSerialization<byte>.WriteDelta(writer, ref ptr[i], ref prevPtr[i]);
|
|
}
|
|
else
|
|
{
|
|
NetworkVariableSerialization<byte>.Write(writer, ref ptr[i]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
public unsafe void ReadDelta(FastBufferReader reader, ref T value)
|
|
{
|
|
// Writing can use the NativeArray logic as it is, but reading is a little different.
|
|
// Using the NativeArray logic for reading would result in length changes allocating a new NativeArray,
|
|
// which is not what we want for FixedString. With FixedString, the actual size of the data does not change,
|
|
// only an in-memory "length" value - so if the length changes, the only thing we want to do is change
|
|
// that value, and otherwise read everything in-place.
|
|
reader.ReadByteSafe(out byte full);
|
|
if (full == 1)
|
|
{
|
|
reader.ReadValueSafeInPlace(ref value);
|
|
return;
|
|
}
|
|
ByteUnpacker.ReadValuePacked(reader, out int length);
|
|
var changes = new ResizableBitVector(Allocator.Temp);
|
|
using var toDispose = changes;
|
|
{
|
|
reader.ReadNetworkSerializableInPlace(ref changes);
|
|
|
|
value.Length = length;
|
|
|
|
byte* ptr = value.GetUnsafePtr();
|
|
for (var i = 0; i < value.Length; ++i)
|
|
{
|
|
if (changes.IsSet(i))
|
|
{
|
|
reader.ReadByte(out ptr[i]);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void INetworkVariableSerializer<T>.ReadWithAllocator(FastBufferReader reader, out T value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in T value, ref T duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Serializer for FixedStrings
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class FixedStringArraySerializer<T> : INetworkVariableSerializer<NativeArray<T>> where T : unmanaged, INativeList<byte>, IUTF8Bytes
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeArray<T> value)
|
|
{
|
|
writer.WriteValueSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeArray<T> value)
|
|
{
|
|
value.Dispose();
|
|
reader.ReadValueSafe(out value, Allocator.Persistent);
|
|
}
|
|
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeArray<T> value, ref NativeArray<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeArrayDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeArray<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeArrayDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeArray<T>>.ReadWithAllocator(FastBufferReader reader, out NativeArray<T> value, Allocator allocator)
|
|
{
|
|
reader.ReadValueSafe(out value, allocator);
|
|
}
|
|
|
|
public void Duplicate(in NativeArray<T> value, ref NativeArray<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated || duplicatedValue.Length != value.Length)
|
|
{
|
|
if (duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue.Dispose();
|
|
}
|
|
|
|
duplicatedValue = new NativeArray<T>(value.Length, Allocator.Persistent, NativeArrayOptions.UninitializedMemory);
|
|
}
|
|
|
|
duplicatedValue.CopyFrom(value);
|
|
}
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Serializer for FixedStrings
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class FixedStringListSerializer<T> : INetworkVariableSerializer<NativeList<T>> where T : unmanaged, INativeList<byte>, IUTF8Bytes
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeList<T> value)
|
|
{
|
|
writer.WriteValueSafe(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeList<T> value)
|
|
{
|
|
reader.ReadValueSafeInPlace(ref value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeList<T> value, ref NativeList<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeListDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeList<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeListDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeList<T>>.ReadWithAllocator(FastBufferReader reader, out NativeList<T> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in NativeList<T> value, ref NativeList<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue = new NativeList<T>(value.Length, Allocator.Persistent);
|
|
}
|
|
else if (value.Length != duplicatedValue.Length)
|
|
{
|
|
duplicatedValue.ResizeUninitialized(value.Length);
|
|
}
|
|
|
|
duplicatedValue.CopyFrom(value);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Serializer for unmanaged INetworkSerializable types
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class UnmanagedNetworkSerializableSerializer<T> : INetworkVariableSerializer<T> where T : unmanaged, INetworkSerializable
|
|
{
|
|
public void Write(FastBufferWriter writer, ref T value)
|
|
{
|
|
var bufferSerializer = new BufferSerializer<BufferSerializerWriter>(new BufferSerializerWriter(writer));
|
|
value.NetworkSerialize(bufferSerializer);
|
|
}
|
|
public void Read(FastBufferReader reader, ref T value)
|
|
{
|
|
var bufferSerializer = new BufferSerializer<BufferSerializerReader>(new BufferSerializerReader(reader));
|
|
value.NetworkSerialize(bufferSerializer);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.WriteDelta != null && UserNetworkVariableSerialization<T>.ReadDelta != null)
|
|
{
|
|
UserNetworkVariableSerialization<T>.WriteDelta(writer, value, previousValue);
|
|
return;
|
|
}
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref T value)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.WriteDelta != null && UserNetworkVariableSerialization<T>.ReadDelta != null)
|
|
{
|
|
UserNetworkVariableSerialization<T>.ReadDelta(reader, ref value);
|
|
return;
|
|
}
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<T>.ReadWithAllocator(FastBufferReader reader, out T value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in T value, ref T duplicatedValue)
|
|
{
|
|
duplicatedValue = value;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Serializer for unmanaged INetworkSerializable types
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class UnmanagedNetworkSerializableArraySerializer<T> : INetworkVariableSerializer<NativeArray<T>> where T : unmanaged, INetworkSerializable
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeArray<T> value)
|
|
{
|
|
writer.WriteNetworkSerializable(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeArray<T> value)
|
|
{
|
|
value.Dispose();
|
|
reader.ReadNetworkSerializable(out value, Allocator.Persistent);
|
|
}
|
|
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeArray<T> value, ref NativeArray<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeArrayDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeArray<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeArrayDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeArray<T>>.ReadWithAllocator(FastBufferReader reader, out NativeArray<T> value, Allocator allocator)
|
|
{
|
|
reader.ReadNetworkSerializable(out value, allocator);
|
|
}
|
|
|
|
public void Duplicate(in NativeArray<T> value, ref NativeArray<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated || duplicatedValue.Length != value.Length)
|
|
{
|
|
if (duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue.Dispose();
|
|
}
|
|
|
|
duplicatedValue = new NativeArray<T>(value.Length, Allocator.Persistent, NativeArrayOptions.UninitializedMemory);
|
|
}
|
|
|
|
duplicatedValue.CopyFrom(value);
|
|
}
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Serializer for unmanaged INetworkSerializable types
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class UnmanagedNetworkSerializableListSerializer<T> : INetworkVariableSerializer<NativeList<T>> where T : unmanaged, INetworkSerializable
|
|
{
|
|
public void Write(FastBufferWriter writer, ref NativeList<T> value)
|
|
{
|
|
writer.WriteNetworkSerializable(value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref NativeList<T> value)
|
|
{
|
|
reader.ReadNetworkSerializableInPlace(ref value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref NativeList<T> value, ref NativeList<T> previousValue)
|
|
{
|
|
CollectionSerializationUtility.WriteNativeListDelta(writer, ref value, ref previousValue);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref NativeList<T> value)
|
|
{
|
|
CollectionSerializationUtility.ReadNativeListDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<NativeList<T>>.ReadWithAllocator(FastBufferReader reader, out NativeList<T> value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in NativeList<T> value, ref NativeList<T> duplicatedValue)
|
|
{
|
|
if (!duplicatedValue.IsCreated)
|
|
{
|
|
duplicatedValue = new NativeList<T>(value.Length, Allocator.Persistent);
|
|
}
|
|
else if (value.Length != duplicatedValue.Length)
|
|
{
|
|
duplicatedValue.ResizeUninitialized(value.Length);
|
|
}
|
|
|
|
duplicatedValue.CopyFrom(value);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Serializer for managed INetworkSerializable types, which differs from the unmanaged implementation in that it
|
|
/// has to be null-aware
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class ManagedNetworkSerializableSerializer<T> : INetworkVariableSerializer<T> where T : class, INetworkSerializable, new()
|
|
{
|
|
public void Write(FastBufferWriter writer, ref T value)
|
|
{
|
|
var bufferSerializer = new BufferSerializer<BufferSerializerWriter>(new BufferSerializerWriter(writer));
|
|
bool isNull = (value == null);
|
|
bufferSerializer.SerializeValue(ref isNull);
|
|
if (!isNull)
|
|
{
|
|
value.NetworkSerialize(bufferSerializer);
|
|
}
|
|
}
|
|
public void Read(FastBufferReader reader, ref T value)
|
|
{
|
|
var bufferSerializer = new BufferSerializer<BufferSerializerReader>(new BufferSerializerReader(reader));
|
|
bool isNull = false;
|
|
bufferSerializer.SerializeValue(ref isNull);
|
|
if (isNull)
|
|
{
|
|
value = null;
|
|
}
|
|
else
|
|
{
|
|
if (value == null)
|
|
{
|
|
value = new T();
|
|
}
|
|
value.NetworkSerialize(bufferSerializer);
|
|
}
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.WriteDelta != null && UserNetworkVariableSerialization<T>.ReadDelta != null)
|
|
{
|
|
UserNetworkVariableSerialization<T>.WriteDelta(writer, value, previousValue);
|
|
return;
|
|
}
|
|
Write(writer, ref value);
|
|
}
|
|
public void ReadDelta(FastBufferReader reader, ref T value)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.WriteDelta != null && UserNetworkVariableSerialization<T>.ReadDelta != null)
|
|
{
|
|
UserNetworkVariableSerialization<T>.ReadDelta(reader, ref value);
|
|
return;
|
|
}
|
|
Read(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<T>.ReadWithAllocator(FastBufferReader reader, out T value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in T value, ref T duplicatedValue)
|
|
{
|
|
using var writer = new FastBufferWriter(256, Allocator.Temp, int.MaxValue);
|
|
var refValue = value;
|
|
Write(writer, ref refValue);
|
|
|
|
using var reader = new FastBufferReader(writer, Allocator.None);
|
|
Read(reader, ref duplicatedValue);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// This class is used to register user serialization with NetworkVariables for types
|
|
/// that are serialized via user serialization, such as with FastBufferReader and FastBufferWriter
|
|
/// extension methods. Finding those methods isn't achievable efficiently at runtime, so this allows
|
|
/// users to tell NetworkVariable about those extension methods (or simply pass in a lambda)
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public class UserNetworkVariableSerialization<T>
|
|
{
|
|
/// <summary>
|
|
/// The write value delegate handler definition
|
|
/// </summary>
|
|
/// <param name="writer">The <see cref="FastBufferWriter"/> to write the value of type `T`</param>
|
|
/// <param name="value">The value of type `T` to be written</param>
|
|
public delegate void WriteValueDelegate(FastBufferWriter writer, in T value);
|
|
|
|
/// <summary>
|
|
/// The write value delegate handler definition
|
|
/// </summary>
|
|
/// <param name="writer">The <see cref="FastBufferWriter"/> to write the value of type `T`</param>
|
|
/// <param name="value">The value of type `T` to be written</param>
|
|
public delegate void WriteDeltaDelegate(FastBufferWriter writer, in T value, in T previousValue);
|
|
|
|
/// <summary>
|
|
/// The read value delegate handler definition
|
|
/// </summary>
|
|
/// <param name="reader">The <see cref="FastBufferReader"/> to read the value of type `T`</param>
|
|
/// <param name="value">The value of type `T` to be read</param>
|
|
public delegate void ReadValueDelegate(FastBufferReader reader, out T value);
|
|
|
|
/// <summary>
|
|
/// The read value delegate handler definition
|
|
/// </summary>
|
|
/// <param name="reader">The <see cref="FastBufferReader"/> to read the value of type `T`</param>
|
|
/// <param name="value">The value of type `T` to be read</param>
|
|
public delegate void ReadDeltaDelegate(FastBufferReader reader, ref T value);
|
|
|
|
/// <summary>
|
|
/// The read value delegate handler definition
|
|
/// </summary>
|
|
/// <param name="reader">The <see cref="FastBufferReader"/> to read the value of type `T`</param>
|
|
/// <param name="value">The value of type `T` to be read</param>
|
|
public delegate void DuplicateValueDelegate(in T value, ref T duplicatedValue);
|
|
|
|
/// <summary>
|
|
/// Callback to write a value
|
|
/// </summary>
|
|
public static WriteValueDelegate WriteValue;
|
|
|
|
/// <summary>
|
|
/// Callback to read a value
|
|
/// </summary>
|
|
public static ReadValueDelegate ReadValue;
|
|
|
|
/// <summary>
|
|
/// Callback to write a delta between two values, based on computing the difference between the previous and
|
|
/// current values.
|
|
/// </summary>
|
|
public static WriteDeltaDelegate WriteDelta;
|
|
|
|
/// <summary>
|
|
/// Callback to read a delta, applying only select changes to the current value.
|
|
/// </summary>
|
|
public static ReadDeltaDelegate ReadDelta;
|
|
|
|
/// <summary>
|
|
/// Callback to create a duplicate of a value, used to check for dirty status.
|
|
/// </summary>
|
|
public static DuplicateValueDelegate DuplicateValue;
|
|
}
|
|
|
|
/// <summary>
|
|
/// This class is instantiated for types that we can't determine ahead of time are serializable - types
|
|
/// that don't meet any of the constraints for methods that are available on FastBufferReader and
|
|
/// FastBufferWriter. These types may or may not be serializable through extension methods. To ensure
|
|
/// the user has time to pass in the delegates to UserNetworkVariableSerialization, the existence
|
|
/// of user serialization isn't checked until it's used, so if no serialization is provided, this
|
|
/// will throw an exception when an object containing the relevant NetworkVariable is spawned.
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
internal class FallbackSerializer<T> : INetworkVariableSerializer<T>
|
|
{
|
|
private void ThrowArgumentError()
|
|
{
|
|
throw new ArgumentException($"Serialization has not been generated for type {typeof(T).FullName}. This can be addressed by adding a [{nameof(GenerateSerializationForGenericParameterAttribute)}] to your generic class that serializes this value (if you are using one), adding [{nameof(GenerateSerializationForTypeAttribute)}(typeof({typeof(T).FullName})] to the class or method that is attempting to serialize it, or creating a field on a {nameof(NetworkBehaviour)} of type {nameof(NetworkVariable<T>)}. If this error continues to appear after doing one of those things and this is a type you can change, then either implement {nameof(INetworkSerializable)} or mark it as serializable by memcpy by adding {nameof(INetworkSerializeByMemcpy)} to its interface list to enable automatic serialization generation. If not, assign serialization code to {nameof(UserNetworkVariableSerialization<T>)}.{nameof(UserNetworkVariableSerialization<T>.WriteValue)}, {nameof(UserNetworkVariableSerialization<T>)}.{nameof(UserNetworkVariableSerialization<T>.ReadValue)}, and {nameof(UserNetworkVariableSerialization<T>)}.{nameof(UserNetworkVariableSerialization<T>.DuplicateValue)}, or if it's serializable by memcpy (contains no pointers), wrap it in {typeof(ForceNetworkSerializeByMemcpy<>).Name}.");
|
|
}
|
|
|
|
public void Write(FastBufferWriter writer, ref T value)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.ReadValue == null || UserNetworkVariableSerialization<T>.WriteValue == null || UserNetworkVariableSerialization<T>.DuplicateValue == null)
|
|
{
|
|
ThrowArgumentError();
|
|
}
|
|
UserNetworkVariableSerialization<T>.WriteValue(writer, value);
|
|
}
|
|
public void Read(FastBufferReader reader, ref T value)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.ReadValue == null || UserNetworkVariableSerialization<T>.WriteValue == null || UserNetworkVariableSerialization<T>.DuplicateValue == null)
|
|
{
|
|
ThrowArgumentError();
|
|
}
|
|
UserNetworkVariableSerialization<T>.ReadValue(reader, out value);
|
|
}
|
|
|
|
public void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.ReadValue == null || UserNetworkVariableSerialization<T>.WriteValue == null || UserNetworkVariableSerialization<T>.DuplicateValue == null)
|
|
{
|
|
ThrowArgumentError();
|
|
}
|
|
|
|
if (UserNetworkVariableSerialization<T>.WriteDelta == null || UserNetworkVariableSerialization<T>.ReadDelta == null)
|
|
{
|
|
UserNetworkVariableSerialization<T>.WriteValue(writer, value);
|
|
return;
|
|
}
|
|
UserNetworkVariableSerialization<T>.WriteDelta(writer, value, previousValue);
|
|
}
|
|
|
|
public void ReadDelta(FastBufferReader reader, ref T value)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.ReadValue == null || UserNetworkVariableSerialization<T>.WriteValue == null || UserNetworkVariableSerialization<T>.DuplicateValue == null)
|
|
{
|
|
ThrowArgumentError();
|
|
}
|
|
|
|
if (UserNetworkVariableSerialization<T>.WriteDelta == null || UserNetworkVariableSerialization<T>.ReadDelta == null)
|
|
{
|
|
UserNetworkVariableSerialization<T>.ReadValue(reader, out value);
|
|
return;
|
|
}
|
|
UserNetworkVariableSerialization<T>.ReadDelta(reader, ref value);
|
|
}
|
|
|
|
void INetworkVariableSerializer<T>.ReadWithAllocator(FastBufferReader reader, out T value, Allocator allocator)
|
|
{
|
|
throw new NotImplementedException();
|
|
}
|
|
|
|
public void Duplicate(in T value, ref T duplicatedValue)
|
|
{
|
|
if (UserNetworkVariableSerialization<T>.ReadValue == null || UserNetworkVariableSerialization<T>.WriteValue == null || UserNetworkVariableSerialization<T>.DuplicateValue == null)
|
|
{
|
|
ThrowArgumentError();
|
|
}
|
|
UserNetworkVariableSerialization<T>.DuplicateValue(value, ref duplicatedValue);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// This class contains initialization functions for various different types used in NetworkVariables.
|
|
/// Generally speaking, these methods are called by a module initializer created by codegen (NetworkBehaviourILPP)
|
|
/// and do not need to be called manually.
|
|
///
|
|
/// There are two types of initializers: Serializers and EqualityCheckers. Every type must have an EqualityChecker
|
|
/// registered to it in order to be used in NetworkVariable; however, not all types need a Serializer. Types without
|
|
/// a serializer registered will fall back to using the delegates in <see cref="UserNetworkVariableSerialization{T}"/>.
|
|
/// If no such delegate has been registered, a type without a serializer will throw an exception on the first attempt
|
|
/// to serialize or deserialize it. (Again, however, codegen handles this automatically and this registration doesn't
|
|
/// typically need to be performed manually.)
|
|
/// </summary>
|
|
public static class NetworkVariableSerializationTypes
|
|
{
|
|
[RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.AfterAssembliesLoaded)]
|
|
#if UNITY_EDITOR
|
|
[InitializeOnLoadMethod]
|
|
#endif
|
|
internal static void InitializeIntegerSerialization()
|
|
{
|
|
NetworkVariableSerialization<short>.Serializer = new ShortSerializer();
|
|
NetworkVariableSerialization<short>.AreEqual = NetworkVariableSerialization<short>.ValueEquals;
|
|
NetworkVariableSerialization<ushort>.Serializer = new UshortSerializer();
|
|
NetworkVariableSerialization<ushort>.AreEqual = NetworkVariableSerialization<ushort>.ValueEquals;
|
|
NetworkVariableSerialization<int>.Serializer = new IntSerializer();
|
|
NetworkVariableSerialization<int>.AreEqual = NetworkVariableSerialization<int>.ValueEquals;
|
|
NetworkVariableSerialization<uint>.Serializer = new UintSerializer();
|
|
NetworkVariableSerialization<uint>.AreEqual = NetworkVariableSerialization<uint>.ValueEquals;
|
|
NetworkVariableSerialization<long>.Serializer = new LongSerializer();
|
|
NetworkVariableSerialization<long>.AreEqual = NetworkVariableSerialization<long>.ValueEquals;
|
|
NetworkVariableSerialization<ulong>.Serializer = new UlongSerializer();
|
|
NetworkVariableSerialization<ulong>.AreEqual = NetworkVariableSerialization<ulong>.ValueEquals;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registeres an unmanaged type that will be serialized by a direct memcpy into a buffer
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_UnmanagedByMemcpy<T>() where T : unmanaged
|
|
{
|
|
NetworkVariableSerialization<T>.Serializer = new UnmanagedTypeSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registeres an unmanaged type that will be serialized by a direct memcpy into a buffer
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_UnmanagedByMemcpyArray<T>() where T : unmanaged
|
|
{
|
|
NetworkVariableSerialization<NativeArray<T>>.Serializer = new UnmanagedArraySerializer<T>();
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Registeres an unmanaged type that will be serialized by a direct memcpy into a buffer
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_UnmanagedByMemcpyList<T>() where T : unmanaged
|
|
{
|
|
NetworkVariableSerialization<NativeList<T>>.Serializer = new UnmanagedListSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registeres a native hash set (this generic implementation works with all types)
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_NativeHashSet<T>() where T : unmanaged, IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<NativeHashSet<T>>.Serializer = new NativeHashSetSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registeres a native hash set (this generic implementation works with all types)
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_NativeHashMap<TKey, TVal>()
|
|
where TKey : unmanaged, IEquatable<TKey>
|
|
where TVal : unmanaged
|
|
{
|
|
NetworkVariableSerialization<NativeHashMap<TKey, TVal>>.Serializer = new NativeHashMapSerializer<TKey, TVal>();
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Registeres a native hash set (this generic implementation works with all types)
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_List<T>()
|
|
{
|
|
NetworkVariableSerialization<List<T>>.Serializer = new ListSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registeres a native hash set (this generic implementation works with all types)
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_HashSet<T>() where T : IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<HashSet<T>>.Serializer = new HashSetSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registeres a native hash set (this generic implementation works with all types)
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_Dictionary<TKey, TVal>() where TKey : IEquatable<TKey>
|
|
{
|
|
NetworkVariableSerialization<Dictionary<TKey, TVal>>.Serializer = new DictionarySerializer<TKey, TVal>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an unmanaged type that implements INetworkSerializable and will be serialized through a call to
|
|
/// NetworkSerialize
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_UnmanagedINetworkSerializable<T>() where T : unmanaged, INetworkSerializable
|
|
{
|
|
NetworkVariableSerialization<T>.Serializer = new UnmanagedNetworkSerializableSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an unmanaged type that implements INetworkSerializable and will be serialized through a call to
|
|
/// NetworkSerialize
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_UnmanagedINetworkSerializableArray<T>() where T : unmanaged, INetworkSerializable
|
|
{
|
|
NetworkVariableSerialization<NativeArray<T>>.Serializer = new UnmanagedNetworkSerializableArraySerializer<T>();
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Registers an unmanaged type that implements INetworkSerializable and will be serialized through a call to
|
|
/// NetworkSerialize
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_UnmanagedINetworkSerializableList<T>() where T : unmanaged, INetworkSerializable
|
|
{
|
|
NetworkVariableSerialization<NativeList<T>>.Serializer = new UnmanagedNetworkSerializableListSerializer<T>();
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Registers a managed type that implements INetworkSerializable and will be serialized through a call to
|
|
/// NetworkSerialize
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_ManagedINetworkSerializable<T>() where T : class, INetworkSerializable, new()
|
|
{
|
|
NetworkVariableSerialization<T>.Serializer = new ManagedNetworkSerializableSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a FixedString type that will be serialized through FastBufferReader/FastBufferWriter's FixedString
|
|
/// serializers
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_FixedString<T>() where T : unmanaged, INativeList<byte>, IUTF8Bytes
|
|
{
|
|
NetworkVariableSerialization<T>.Serializer = new FixedStringSerializer<T>();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers a FixedString type that will be serialized through FastBufferReader/FastBufferWriter's FixedString
|
|
/// serializers
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_FixedStringArray<T>() where T : unmanaged, INativeList<byte>, IUTF8Bytes
|
|
{
|
|
NetworkVariableSerialization<NativeArray<T>>.Serializer = new FixedStringArraySerializer<T>();
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Registers a FixedString type that will be serialized through FastBufferReader/FastBufferWriter's FixedString
|
|
/// serializers
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeSerializer_FixedStringList<T>() where T : unmanaged, INativeList<byte>, IUTF8Bytes
|
|
{
|
|
NetworkVariableSerialization<NativeList<T>>.Serializer = new FixedStringListSerializer<T>();
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Registers a managed type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_ManagedIEquatable<T>() where T : class, IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<T>.AreEqual = NetworkVariableSerialization<T>.EqualityEqualsObject;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_UnmanagedIEquatable<T>() where T : unmanaged, IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<T>.AreEqual = NetworkVariableSerialization<T>.EqualityEquals;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_UnmanagedIEquatableArray<T>() where T : unmanaged, IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<NativeArray<T>>.AreEqual = NetworkVariableSerialization<T>.EqualityEqualsArray;
|
|
}
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_List<T>()
|
|
{
|
|
NetworkVariableSerialization<List<T>>.AreEqual = NetworkVariableSerialization<T>.EqualityEqualsList;
|
|
}
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_HashSet<T>() where T : IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<HashSet<T>>.AreEqual = NetworkVariableSerialization<T>.EqualityEqualsHashSet;
|
|
}
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_Dictionary<TKey, TVal>()
|
|
where TKey : IEquatable<TKey>
|
|
{
|
|
NetworkVariableSerialization<Dictionary<TKey, TVal>>.AreEqual = NetworkVariableDictionarySerialization<TKey, TVal>.GenericEqualsDictionary;
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_UnmanagedIEquatableList<T>() where T : unmanaged, IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<NativeList<T>>.AreEqual = NetworkVariableSerialization<T>.EqualityEqualsNativeList;
|
|
}
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_NativeHashSet<T>() where T : unmanaged, IEquatable<T>
|
|
{
|
|
NetworkVariableSerialization<NativeHashSet<T>>.AreEqual = NetworkVariableSerialization<T>.EqualityEqualsNativeHashSet;
|
|
}
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using T.Equals()
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_NativeHashMap<TKey, TVal>()
|
|
where TKey : unmanaged, IEquatable<TKey>
|
|
where TVal : unmanaged
|
|
{
|
|
NetworkVariableSerialization<NativeHashMap<TKey, TVal>>.AreEqual = NetworkVariableMapSerialization<TKey, TVal>.GenericEqualsNativeHashMap;
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using memcmp and only considered
|
|
/// equal if they are bitwise equivalent in memory
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_UnmanagedValueEquals<T>() where T : unmanaged
|
|
{
|
|
NetworkVariableSerialization<T>.AreEqual = NetworkVariableSerialization<T>.ValueEquals;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using memcmp and only considered
|
|
/// equal if they are bitwise equivalent in memory
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_UnmanagedValueEqualsArray<T>() where T : unmanaged
|
|
{
|
|
NetworkVariableSerialization<NativeArray<T>>.AreEqual = NetworkVariableSerialization<T>.ValueEqualsArray;
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
/// <summary>
|
|
/// Registers an unmanaged type that will be checked for equality using memcmp and only considered
|
|
/// equal if they are bitwise equivalent in memory
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_UnmanagedValueEqualsList<T>() where T : unmanaged
|
|
{
|
|
NetworkVariableSerialization<NativeList<T>>.AreEqual = NetworkVariableSerialization<T>.ValueEqualsList;
|
|
}
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Registers a managed type that will be checked for equality using the == operator
|
|
/// </summary>
|
|
/// <typeparam name="T"></typeparam>
|
|
public static void InitializeEqualityChecker_ManagedClassEquals<T>() where T : class
|
|
{
|
|
NetworkVariableSerialization<T>.AreEqual = NetworkVariableSerialization<T>.ClassEquals;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type the associated NetworkVariable is templated on</typeparam>
|
|
[Serializable]
|
|
public static class NetworkVariableSerialization<T>
|
|
{
|
|
internal static INetworkVariableSerializer<T> Serializer = new FallbackSerializer<T>();
|
|
|
|
/// <summary>
|
|
/// A callback to check if two values are equal.
|
|
/// </summary>
|
|
public delegate bool EqualsDelegate(ref T a, ref T b);
|
|
|
|
/// <summary>
|
|
/// Uses the most efficient mechanism for a given type to determine if two values are equal.
|
|
/// For types that implement <see cref="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.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// Note: If you are using this in a custom generic class, please make sure your class is
|
|
/// decorated with <see cref="GenerateSerializationForGenericParameterAttribute"/> so that codegen can
|
|
/// initialize the serialization mechanisms correctly. If your class is NOT
|
|
/// generic, it is better to check their equality yourself.
|
|
/// </summary>
|
|
public static EqualsDelegate AreEqual { get; internal set; }
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// Note: If you are using this in a custom generic class, please make sure your class is
|
|
/// decorated with <see cref="GenerateSerializationForGenericParameterAttribute"/> so that codegen can
|
|
/// initialize the serialization mechanisms correctly. If your class is NOT
|
|
/// generic, it is better to use FastBufferWriter directly.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// If the codegen is unable to determine a serializer for a type,
|
|
/// <see cref="UserNetworkVariableSerialization{T}"/>.<see cref="UserNetworkVariableSerialization{T}.WriteValue"/> is called, which, by default,
|
|
/// will throw an exception, unless you have assigned a user serialization callback to it at runtime.
|
|
/// </summary>
|
|
/// <param name="writer"></param>
|
|
/// <param name="value"></param>
|
|
public static void Write(FastBufferWriter writer, ref T value)
|
|
{
|
|
Serializer.Write(writer, ref value);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// Note: If you are using this in a custom generic class, please make sure your class is
|
|
/// decorated with <see cref="GenerateSerializationForGenericParameterAttribute"/> so that codegen can
|
|
/// initialize the serialization mechanisms correctly. If your class is NOT
|
|
/// generic, it is better to use FastBufferReader directly.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// If the codegen is unable to determine a serializer for a type,
|
|
/// <see cref="UserNetworkVariableSerialization{T}"/>.<see cref="UserNetworkVariableSerialization{T}.ReadValue"/> is called, which, by default,
|
|
/// will throw an exception, unless you have assigned a user deserialization callback to it at runtime.
|
|
/// </summary>
|
|
/// <param name="reader"></param>
|
|
/// <param name="value"></param>
|
|
public static void Read(FastBufferReader reader, ref T value)
|
|
{
|
|
Serializer.Read(reader, ref value);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// Note: If you are using this in a custom generic class, please make sure your class is
|
|
/// decorated with <see cref="GenerateSerializationForGenericParameterAttribute"/> so that codegen can
|
|
/// initialize the serialization mechanisms correctly. If your class is NOT
|
|
/// generic, it is better to use FastBufferWriter directly.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// If the codegen is unable to determine a serializer for a type,
|
|
/// <see cref="UserNetworkVariableSerialization{T}"/>.<see cref="UserNetworkVariableSerialization{T}.WriteValue"/> is called, which, by default,
|
|
/// will throw an exception, unless you have assigned a user serialization callback to it at runtime.
|
|
/// </summary>
|
|
/// <param name="writer"></param>
|
|
/// <param name="value"></param>
|
|
public static void WriteDelta(FastBufferWriter writer, ref T value, ref T previousValue)
|
|
{
|
|
Serializer.WriteDelta(writer, ref value, ref previousValue);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// Note: If you are using this in a custom generic class, please make sure your class is
|
|
/// decorated with <see cref="GenerateSerializationForGenericParameterAttribute"/> so that codegen can
|
|
/// initialize the serialization mechanisms correctly. If your class is NOT
|
|
/// generic, it is better to use FastBufferReader directly.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// If the codegen is unable to determine a serializer for a type,
|
|
/// <see cref="UserNetworkVariableSerialization{T}"/>.<see cref="UserNetworkVariableSerialization{T}.ReadValue"/> is called, which, by default,
|
|
/// will throw an exception, unless you have assigned a user deserialization callback to it at runtime.
|
|
/// </summary>
|
|
/// <param name="reader"></param>
|
|
/// <param name="value"></param>
|
|
public static void ReadDelta(FastBufferReader reader, ref T value)
|
|
{
|
|
Serializer.ReadDelta(reader, ref value);
|
|
}
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// Note: If you are using this in a custom generic class, please make sure your class is
|
|
/// decorated with <see cref="GenerateSerializationForGenericParameterAttribute"/> so that codegen can
|
|
/// initialize the serialization mechanisms correctly. If your class is NOT
|
|
/// generic, it is better to duplicate it directly.
|
|
/// <br/>
|
|
/// <br/>
|
|
/// If the codegen is unable to determine a serializer for a type,
|
|
/// <see cref="UserNetworkVariableSerialization{T}"/>.<see cref="UserNetworkVariableSerialization{T}.DuplicateValue"/> is called, which, by default,
|
|
/// will throw an exception, unless you have assigned a user duplication callback to it at runtime.
|
|
/// </summary>
|
|
/// <param name="value"></param>
|
|
/// <param name="duplicatedValue"></param>
|
|
public static void Duplicate(in T value, ref T duplicatedValue)
|
|
{
|
|
Serializer.Duplicate(value, ref duplicatedValue);
|
|
}
|
|
|
|
// Compares two values of the same unmanaged type by underlying memory
|
|
// Ignoring any overridden value checks
|
|
// Size is fixed
|
|
internal static unsafe bool ValueEquals<TValueType>(ref TValueType a, ref TValueType b) where TValueType : unmanaged
|
|
{
|
|
// get unmanaged pointers
|
|
var aptr = UnsafeUtility.AddressOf(ref a);
|
|
var bptr = UnsafeUtility.AddressOf(ref b);
|
|
|
|
// compare addresses
|
|
return UnsafeUtility.MemCmp(aptr, bptr, sizeof(TValueType)) == 0;
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
// Compares two values of the same unmanaged type by underlying memory
|
|
// Ignoring any overridden value checks
|
|
// Size is fixed
|
|
internal static unsafe bool ValueEqualsList<TValueType>(ref NativeList<TValueType> a, ref NativeList<TValueType> b) where TValueType : unmanaged
|
|
{
|
|
if (a.IsCreated != b.IsCreated)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (!a.IsCreated)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Length != b.Length)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var aptr = (TValueType*)a.GetUnsafePtr();
|
|
var bptr = (TValueType*)b.GetUnsafePtr();
|
|
return UnsafeUtility.MemCmp(aptr, bptr, sizeof(TValueType) * a.Length) == 0;
|
|
}
|
|
#endif
|
|
|
|
// Compares two values of the same unmanaged type by underlying memory
|
|
// Ignoring any overridden value checks
|
|
// Size is fixed
|
|
internal static unsafe bool ValueEqualsArray<TValueType>(ref NativeArray<TValueType> a, ref NativeArray<TValueType> b) where TValueType : unmanaged
|
|
{
|
|
if (a.IsCreated != b.IsCreated)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (!a.IsCreated)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Length != b.Length)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var aptr = (TValueType*)a.GetUnsafePtr();
|
|
var bptr = (TValueType*)b.GetUnsafePtr();
|
|
return UnsafeUtility.MemCmp(aptr, bptr, sizeof(TValueType) * a.Length) == 0;
|
|
}
|
|
|
|
internal static bool EqualityEqualsObject<TValueType>(ref TValueType a, ref TValueType b) where TValueType : class, IEquatable<TValueType>
|
|
{
|
|
if (a == null)
|
|
{
|
|
return b == null;
|
|
}
|
|
|
|
if (b == null)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
return a.Equals(b);
|
|
}
|
|
|
|
internal static bool EqualityEquals<TValueType>(ref TValueType a, ref TValueType b) where TValueType : unmanaged, IEquatable<TValueType>
|
|
{
|
|
return a.Equals(b);
|
|
}
|
|
|
|
internal static bool EqualityEqualsList<TValueType>(ref List<TValueType> a, ref List<TValueType> b)
|
|
{
|
|
if ((a == null) != (b == null))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (a == null)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Count != b.Count)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
for (var i = 0; i < a.Count; ++i)
|
|
{
|
|
var aItem = a[i];
|
|
var bItem = b[i];
|
|
if (!NetworkVariableSerialization<TValueType>.AreEqual(ref aItem, ref bItem))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
internal static bool EqualityEqualsHashSet<TValueType>(ref HashSet<TValueType> a, ref HashSet<TValueType> b) where TValueType : IEquatable<TValueType>
|
|
{
|
|
if ((a == null) != (b == null))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (a == null)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Count != b.Count)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
foreach (var item in a)
|
|
{
|
|
if (!b.Contains(item))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
// Compares two values of the same unmanaged type by underlying memory
|
|
// Ignoring any overridden value checks
|
|
// Size is fixed
|
|
internal static unsafe bool EqualityEqualsNativeList<TValueType>(ref NativeList<TValueType> a, ref NativeList<TValueType> b) where TValueType : unmanaged, IEquatable<TValueType>
|
|
{
|
|
if (a.IsCreated != b.IsCreated)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (!a.IsCreated)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Length != b.Length)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var aptr = (TValueType*)a.GetUnsafePtr();
|
|
var bptr = (TValueType*)b.GetUnsafePtr();
|
|
for (var i = 0; i < a.Length; ++i)
|
|
{
|
|
if (!EqualityEquals(ref aptr[i], ref bptr[i]))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
internal static bool EqualityEqualsNativeHashSet<TValueType>(ref NativeHashSet<TValueType> a, ref NativeHashSet<TValueType> b) where TValueType : unmanaged, IEquatable<TValueType>
|
|
{
|
|
if (a.IsCreated != b.IsCreated)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (!a.IsCreated)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Count() != b.Count())
|
|
{
|
|
return false;
|
|
}
|
|
|
|
foreach (var item in a)
|
|
{
|
|
if (!b.Contains(item))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
#endif
|
|
|
|
// Compares two values of the same unmanaged type by underlying memory
|
|
// Ignoring any overridden value checks
|
|
// Size is fixed
|
|
internal static unsafe bool EqualityEqualsArray<TValueType>(ref NativeArray<TValueType> a, ref NativeArray<TValueType> b) where TValueType : unmanaged, IEquatable<TValueType>
|
|
{
|
|
if (a.IsCreated != b.IsCreated)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (!a.IsCreated)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Length != b.Length)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var aptr = (TValueType*)a.GetUnsafePtr();
|
|
var bptr = (TValueType*)b.GetUnsafePtr();
|
|
for (var i = 0; i < a.Length; ++i)
|
|
{
|
|
if (!EqualityEquals(ref aptr[i], ref bptr[i]))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
internal static bool ClassEquals<TValueType>(ref TValueType a, ref TValueType b) where TValueType : class
|
|
{
|
|
return a == b;
|
|
}
|
|
}
|
|
internal class NetworkVariableDictionarySerialization<TKey, TVal>
|
|
where TKey : IEquatable<TKey>
|
|
{
|
|
|
|
internal static bool GenericEqualsDictionary(ref Dictionary<TKey, TVal> a, ref Dictionary<TKey, TVal> b)
|
|
{
|
|
if ((a == null) != (b == null))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (a == null)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Count != b.Count)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
foreach (var item in a)
|
|
{
|
|
var hasKey = b.TryGetValue(item.Key, out var val);
|
|
if (!hasKey)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
var bVal = item.Value;
|
|
if (!NetworkVariableSerialization<TVal>.AreEqual(ref bVal, ref val))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
#if UNITY_NETCODE_NATIVE_COLLECTION_SUPPORT
|
|
internal class NetworkVariableMapSerialization<TKey, TVal>
|
|
where TKey : unmanaged, IEquatable<TKey>
|
|
where TVal : unmanaged
|
|
{
|
|
|
|
internal static bool GenericEqualsNativeHashMap(ref NativeHashMap<TKey, TVal> a, ref NativeHashMap<TKey, TVal> b)
|
|
{
|
|
if (a.IsCreated != b.IsCreated)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
if (!a.IsCreated)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
if (a.Count() != b.Count())
|
|
{
|
|
return false;
|
|
}
|
|
|
|
foreach (var item in a)
|
|
{
|
|
var hasKey = b.TryGetValue(item.Key, out var val);
|
|
if (!hasKey || !NetworkVariableSerialization<TVal>.AreEqual(ref item.Value, ref val))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
// RuntimeAccessModifiersILPP will make this `public`
|
|
// This is just pass-through to NetworkVariableSerialization<T> but is here becaues I could not get ILPP
|
|
// to generate code that would successfully call Type<T>.Method(T), but it has no problem calling Type.Method<T>(T)
|
|
internal class RpcFallbackSerialization
|
|
{
|
|
public static void Write<T>(FastBufferWriter writer, ref T value)
|
|
{
|
|
NetworkVariableSerialization<T>.Write(writer, ref value);
|
|
}
|
|
|
|
public static void Read<T>(FastBufferReader reader, ref T value)
|
|
{
|
|
NetworkVariableSerialization<T>.Read(reader, ref value);
|
|
}
|
|
}
|
|
}
|