com.unity.netcode@0.1.0-preview.6

## [0.1.0-preview.6] - 2020-02-24
### New features
* Added integration with UnityPhysics, including the lag compensation from DotsSample. To use it you must have the UnityPhysics added to your project.

### Changes
* Unity Transport has been upgraded to 0.3.0 which required some API changes - see "Upgrade guide".
* All `FunctionPointer` instances are cached in statics to reduce the number of calls to compile.
* The helper method RpcExecutor.ExecuteCreateRequestComponent returns the entity it creates.
* Added an interface to NetworkStreamReceiveSystem which is used when creating the driver. It is possible to set NetworkStreamReceiveSystem.s_DriverConstructor to a custom instance during bootstrapping to create drivers in a custom way.
* Removed World.Active workaround since it has been deprecated for a while and is causing problems with conversion at runtime.
* Slightly improved performance by ensuring that all jobs that can be Burst compiled are
* Ghost types are now selected based on the guid of the ghosts prefab asset instead of the archetype. This makes it possible to have multiple different ghosts with the same archetype. If a ghost is not a valid prefab you will get an error during conversion.

### Fixes
* Fixed an issue where ghost prefabs created from GameObject instances were processed by all systems.
* The code gen now only writes files if they are modified.
* Disposing a client or server world will now unregister it from the tick system to prevent errors.
* Take the latency of command age updates into account when calculating time scale to get more stable inputs with high ping.

### Upgrade guide
Unity Transport has been upgraded to 0.3.0 which changes the API for `DataStreamReader` and `DataStreamWriter`.

The `IRpcCommand` and `ICommandData` have been changed to not take a `DataStreamReader.Context`.

The `ISnapshotData` and GhostCollection interfaces have been changed to not take a `DataStreamReader.Context`, all ghosts and collections must be regenerated.

`GhostDistanceImportance.NoScale` and `GhostDistanceImportance.DefaultScale` have been replaced by `GhostDistanceImportance.NoScaleFunctionPointer` and `GhostDistanceImportance.DefaultScaleFunctionPointer` which are compiled function pointers rather than methods.

Author: Unity Technologies

CHANGELOG.md

@@ -1,5 +1,33 @@
 # Change log
 
+## [0.1.0-preview.6] - 2020-02-24
+### New features
+* Added integration with UnityPhysics, including the lag compensation from DotsSample. To use it you must have the UnityPhysics added to your project.
+
+### Changes
+* Unity Transport has been upgraded to 0.3.0 which required some API changes - see "Upgrade guide".
+* All `FunctionPointer` instances are cached in statics to reduce the number of calls to compile.
+* The helper method RpcExecutor.ExecuteCreateRequestComponent returns the entity it creates.
+* Added an interface to NetworkStreamReceiveSystem which is used when creating the driver. It is possible to set NetworkStreamReceiveSystem.s_DriverConstructor to a custom instance during bootstrapping to create drivers in a custom way.
+* Removed World.Active workaround since it has been deprecated for a while and is causing problems with conversion at runtime.
+* Slightly improved performance by ensuring that all jobs that can be Burst compiled are
+* Ghost types are now selected based on the guid of the ghosts prefab asset instead of the archetype. This makes it possible to have multiple different ghosts with the same archetype. If a ghost is not a valid prefab you will get an error during conversion.
+
+### Fixes
+* Fixed an issue where ghost prefabs created from GameObject instances were processed by all systems.
+* The code gen now only writes files if they are modified.
+* Disposing a client or server world will now unregister it from the tick system to prevent errors.
+* Take the latency of command age updates into account when calculating time scale to get more stable inputs with high ping.
+
+### Upgrade guide
+Unity Transport has been upgraded to 0.3.0 which changes the API for `DataStreamReader` and `DataStreamWriter`.
+
+The `IRpcCommand` and `ICommandData` have been changed to not take a `DataStreamReader.Context`.
+
+The `ISnapshotData` and GhostCollection interfaces have been changed to not take a `DataStreamReader.Context`, all ghosts and collections must be regenerated.
+
+`GhostDistanceImportance.NoScale` and `GhostDistanceImportance.DefaultScale` have been replaced by `GhostDistanceImportance.NoScaleFunctionPointer` and `GhostDistanceImportance.DefaultScaleFunctionPointer` which are compiled function pointers rather than methods.
+
 ## [0.0.4-preview.0] - 2019-12-12
 ### New features
 ### Changes

Documentation~/getting-started.md

@@ -4,7 +4,7 @@ This documentation provides a walkthrough of how to create a very simple client
 ## Set up the Project
 Open the __Unity Hub__ and create a new Project. **Note:** To use Unity NetCode you must have at least Unity 2019.3.b11 installed.
 
-Open the Package Manager (menu: __Window > Package Manager__). At the top of the window, under __Advanced__, select __Show preview packages__. Add the Entities, Hybrid Renderer, NetCode, and Transport packages. 
+Open the Package Manager (menu: __Window > Package Manager__). At the top of the window, under __Advanced__, select __Show preview packages__. Add the Entities, Hybrid Renderer, NetCode, and Transport packages.
 
 ## Create an initial Scene
 
@@ -20,9 +20,9 @@ Once you set this up you can, for example, spawn a plane in both the client and
 
 ## Create a ghost Prefab
 
-To make your Scene run with a client / server setup you need to create a definition of the networked object, which is called a **ghost**. 
+To make your Scene run with a client / server setup you need to create a definition of the networked object, which is called a **ghost**.
 
-To create a ghost Prefab, create a cube in the Scene (right click on the Scene and select __3D Object > Cube__). Then select the Cube GameObject under the Scene and drag it into the Project’s __Asset__ folder. This creates a Prefab of the Cube. 
+To create a ghost Prefab, create a cube in the Scene (right click on the Scene and select __3D Object > Cube__). Then select the Cube GameObject under the Scene and drag it into the Project’s __Asset__ folder. This creates a Prefab of the Cube.
 
 ![Create a Cube Prefab](images/cube-prefab.png)<br/>_Create a Cube Prefab_
 
@@ -40,13 +40,13 @@ public struct MovableCubeComponent : IComponentData
 }
 ```
 
-Once you create this component, add it to the Cube Prefab. Then, in the Inspector, add the __Ghost Authoring Component__ to the Prefab. In this component, select __Update Component List__ to update the list of components. 
+Once you create this component, add it to the Cube Prefab. Then, in the Inspector, add the __Ghost Authoring Component__ to the Prefab. In this component, select __Update Component List__ to update the list of components.
 
-When you do this, Unity automatically adds default values to the Translation and Rotation components. Expand the components in the list to select where they should be present. In this example, disable `PerInstanceCullingTag` and `RenderMesh` on the server. This is because the server does not render anything, and interpolated objects on the client don’t simulate anything. 
+When you do this, Unity automatically adds default values to the Translation and Rotation components. Expand the components in the list to select where they should be present. In this example, disable `PerInstanceCullingTag` and `RenderMesh` on the server. This is because the server does not render anything, and interpolated objects on the client don’t simulate anything.
 
 ![The Ghost Authoring component](images/ghost-config.png)<br/>_The Ghost Authoring component_
 
-**Note:** Change the __Default Client Instantiation__ to __Owner Predicted__. This makes sure that you predict your own movement. 
+**Note:** Change the __Default Client Instantiation__ to __Owner Predicted__. This makes sure that you predict your own movement.
 
 After you set up the component, select the __Generate Code__ button.
 
@@ -131,16 +131,18 @@ public struct GoInGameRequest : IRpcCommand
         RpcExecutor.ExecuteCreateRequestComponent<GoInGameRequest>(ref parameters);
     }
 
+    static PortableFunctionPointer<RpcExecutor.ExecuteDelegate> InvokeExecuteFunctionPointer =
+        new PortableFunctionPointer<RpcExecutor.ExecuteDelegate>(InvokeExecute);
     public PortableFunctionPointer<RpcExecutor.ExecuteDelegate> CompileExecute()
     {
-        return new PortableFunctionPointer<RpcExecutor.ExecuteDelegate>(InvokeExecute);
+        return InvokeExecuteFunctionPointer;
     }
 }
 ```
 
 **Note:** Don’t forget the `BurstCompile` attribute on `InvokeExecute`.
 
-To make sure NetCode handles the command, you need to create a [RpcCommandRequestSystem](https://docs.unity3d.com/Packages/com.unity.netcode@latest/index.html?subfolder=/api/Unity.NetCode.RpcCommandRequestSystem-1.html) as follows: 
+To make sure NetCode handles the command, you need to create a [RpcCommandRequestSystem](https://docs.unity3d.com/Packages/com.unity.netcode@latest/index.html?subfolder=/api/Unity.NetCode.RpcCommandRequestSystem-1.html) as follows:
 
 ```c#
 // The system that makes the RPC request component transfer
@@ -313,10 +315,10 @@ public class GoInGameServerSystem : ComponentSystem
             var ghostId = NetCubeGhostSerializerCollection.FindGhostType<CubeSnapshotData>();
             var prefab = EntityManager.GetBuffer<GhostPrefabBuffer>(ghostCollection.serverPrefabs)[ghostId].Value;
             var player = EntityManager.Instantiate(prefab);
-            
+
             EntityManager.SetComponentData(player, new MovableCubeComponent { PlayerId = EntityManager.GetComponentData<NetworkIdComponent>(reqSrc.SourceConnection).Value});
             PostUpdateCommands.AddBuffer<CubeInput>(player);
-            
+
             PostUpdateCommands.SetComponent(reqSrc.SourceConnection, new CommandTargetComponent {targetEntity = player});
 
             PostUpdateCommands.DestroyEntity(reqEnt);

Editor/CodeGenTemplates/GhostDeserializerCollection.cs

@@ -39,29 +39,28 @@ public void BeginDeserialize(JobComponentSystem system)
         #endregion
     }
     public bool Deserialize(int serializer, Entity entity, uint snapshot, uint baseline, uint baseline2, uint baseline3,
-        DataStreamReader reader,
-        ref DataStreamReader.Context ctx, NetworkCompressionModel compressionModel)
+        ref DataStreamReader reader, NetworkCompressionModel compressionModel)
     {
         switch (serializer)
         {
             #region __GHOST_INVOKE_DESERIALIZE__
             case __GHOST_SERIALIZER_INDEX__:
                 return GhostReceiveSystem<__GHOST_COLLECTION_PREFIX__GhostDeserializerCollection>.InvokeDeserialize(m___GHOST_SNAPSHOT_TYPE__FromEntity, entity, snapshot, baseline, baseline2,
-                baseline3, reader, ref ctx, compressionModel);
+                baseline3, ref reader, compressionModel);
             #endregion
             default:
                 throw new ArgumentException("Invalid serializer type");
         }
     }
-    public void Spawn(int serializer, int ghostId, uint snapshot, DataStreamReader reader,
-        ref DataStreamReader.Context ctx, NetworkCompressionModel compressionModel)
+    public void Spawn(int serializer, int ghostId, uint snapshot, ref DataStreamReader reader,
+        NetworkCompressionModel compressionModel)
     {
         switch (serializer)
         {
             #region __GHOST_INVOKE_SPAWN__
             case __GHOST_SERIALIZER_INDEX__:
                 m___GHOST_SNAPSHOT_TYPE__NewGhostIds.Add(ghostId);
-                m___GHOST_SNAPSHOT_TYPE__NewGhosts.Add(GhostReceiveSystem<__GHOST_COLLECTION_PREFIX__GhostDeserializerCollection>.InvokeSpawn<__GHOST_SNAPSHOT_TYPE__>(snapshot, reader, ref ctx, compressionModel));
+                m___GHOST_SNAPSHOT_TYPE__NewGhosts.Add(GhostReceiveSystem<__GHOST_COLLECTION_PREFIX__GhostDeserializerCollection>.InvokeSpawn<__GHOST_SNAPSHOT_TYPE__>(snapshot, ref reader, compressionModel));
                 break;
             #endregion
             default:

Editor/CodeGenTemplates/GhostSerializer.cs

@@ -27,8 +27,6 @@ public int CalculateImportance(ArchetypeChunk chunk)
         return __GHOST_IMPORTANCE__;
     }
 
-    public bool WantsPredictionDelta => true;
-
     public int SnapshotSize => UnsafeUtility.SizeOf<__GHOST_NAME__SnapshotData>();
     public void BeginSerialize(ComponentSystemBase system)
     {
@@ -46,20 +44,6 @@ public void BeginSerialize(ComponentSystemBase system)
         #endregion
     }
 
-    public bool CanSerialize(EntityArchetype arch)
-    {
-        var components = arch.GetComponentTypes();
-        int matches = 0;
-        for (int i = 0; i < components.Length; ++i)
-        {
-            #region __GHOST_COMPONENT_TYPE_CHECK__
-            if (components[i] == componentType__GHOST_COMPONENT_TYPE_NAME__)
-                ++matches;
-            #endregion
-        }
-        return (matches == __GHOST_COMPONENT_COUNT__);
-    }
-
     public void CopyToSnapshot(ArchetypeChunk chunk, int ent, uint tick, ref __GHOST_NAME__SnapshotData snapshot, GhostSerializerState serializerState)
     {
         snapshot.tick = tick;

Editor/CodeGenTemplates/GhostSerializerCollection.cs

@@ -31,14 +31,6 @@ public static int FindGhostType<T>()
         #endregion
         return -1;
     }
-    public int FindSerializer(EntityArchetype arch)
-    {
-        #region __GHOST_FIND_CHECK__
-        if (m___GHOST_SERIALIZER_TYPE__.CanSerialize(arch))
-            return __GHOST_SERIALIZER_INDEX__;
-        #endregion
-        throw new ArgumentException("Invalid serializer type");
-    }
 
     public void BeginSerialize(ComponentSystemBase system)
     {
@@ -60,19 +52,6 @@ public int CalculateImportance(int serializer, ArchetypeChunk chunk)
         throw new ArgumentException("Invalid serializer type");
     }
 
-    public bool WantsPredictionDelta(int serializer)
-    {
-        switch (serializer)
-        {
-            #region __GHOST_WANTS_PREDICTION_DELTA__
-            case __GHOST_SERIALIZER_INDEX__:
-                return m___GHOST_SERIALIZER_TYPE__.WantsPredictionDelta;
-            #endregion
-        }
-
-        throw new ArgumentException("Invalid serializer type");
-    }
-
     public int GetSnapshotSize(int serializer)
     {
         switch (serializer)
@@ -86,14 +65,14 @@ public int GetSnapshotSize(int serializer)
         throw new ArgumentException("Invalid serializer type");
     }
 
-    public int Serialize(SerializeData data)
+    public int Serialize(ref DataStreamWriter dataStream, SerializeData data)
     {
         switch (data.ghostType)
         {
             #region __GHOST_INVOKE_SERIALIZE__
             case __GHOST_SERIALIZER_INDEX__:
             {
-                return GhostSendSystem<__GHOST_COLLECTION_PREFIX__GhostSerializerCollection>.InvokeSerialize<__GHOST_SERIALIZER_TYPE__, __GHOST_SNAPSHOT_TYPE__>(m___GHOST_SERIALIZER_TYPE__, data);
+                return GhostSendSystem<__GHOST_COLLECTION_PREFIX__GhostSerializerCollection>.InvokeSerialize<__GHOST_SERIALIZER_TYPE__, __GHOST_SNAPSHOT_TYPE__>(m___GHOST_SERIALIZER_TYPE__, ref dataStream, data);
             }
             #endregion
             default:

Editor/CodeGenTemplates/GhostSnapshotData.cs

@@ -26,7 +26,7 @@ public void PredictDelta(uint tick, ref __GHOST_NAME__SnapshotData baseline1, re
         #endregion
     }
 
-    public void Serialize(int networkId, ref __GHOST_NAME__SnapshotData baseline, DataStreamWriter writer, NetworkCompressionModel compressionModel)
+    public void Serialize(int networkId, ref __GHOST_NAME__SnapshotData baseline, ref DataStreamWriter writer, NetworkCompressionModel compressionModel)
     {
         #region __GHOST_CALCULATE_CHANGE_MASK__
         #endregion
@@ -59,15 +59,15 @@ public void Serialize(int networkId, ref __GHOST_NAME__SnapshotData baseline, Da
         #endregion
     }
 
-    public void Deserialize(uint tick, ref __GHOST_NAME__SnapshotData baseline, DataStreamReader reader, ref DataStreamReader.Context ctx,
+    public void Deserialize(uint tick, ref __GHOST_NAME__SnapshotData baseline, ref DataStreamReader reader,
         NetworkCompressionModel compressionModel)
     {
         this.tick = tick;
         #region __GHOST_READ_CHANGE_MASK__
-        changeMask__GHOST_MASK_BATCH__ = reader.ReadPackedUIntDelta(ref ctx, baseline.changeMask__GHOST_MASK_BATCH__, compressionModel);
+        changeMask__GHOST_MASK_BATCH__ = reader.ReadPackedUIntDelta(baseline.changeMask__GHOST_MASK_BATCH__, compressionModel);
         #endregion
         #region __GHOST_READ_IS_PREDICTED__
-        bool isPredicted = reader.ReadPackedUInt(ref ctx, compressionModel)!=0;
+        bool isPredicted = reader.ReadPackedUInt(compressionModel)!=0;
         #endregion
         #region __GHOST_READ__
         #endregion

Editor/CodeGenTemplates/GhostUpdateSystem.cs

@@ -329,7 +329,7 @@ protected override JobHandle SetPredictedGhostDefaults(NativeArray<__GHOST_NAME_
         {
             snapshots = snapshots,
             predictionMask = predictionMask,
-            localPlayerId = m_PlayerGroup.ToComponentDataArray<NetworkIdComponent>(Allocator.TempJob, out playerHandle),
+            localPlayerId = m_PlayerGroup.ToComponentDataArrayAsync<NetworkIdComponent>(Allocator.TempJob, out playerHandle),
         };
         return job.Schedule(predictionMask.Length, 8, JobHandle.CombineDependencies(playerHandle, inputDeps));
     }

Editor/CodeGenTemplates/SnapshotValue/GhostSnapshotValueBool.cs

@@ -31,7 +31,7 @@ public void PredictDelta(uint tick, ref GhostSnapshotData baseline1, ref GhostSn
         #endregion
     }
 
-    public void Serialize(int networkId, ref GhostSnapshotData baseline, DataStreamWriter writer, NetworkCompressionModel compressionModel)
+    public void Serialize(int networkId, ref GhostSnapshotData baseline, ref DataStreamWriter writer, NetworkCompressionModel compressionModel)
     {
         #region __GHOST_CALCULATE_CHANGE_MASK_ZERO__
         changeMask__GHOST_MASK_BATCH__ = (__GHOST_FIELD_NAME__ != baseline.__GHOST_FIELD_NAME__) ? 1u : 0;
@@ -45,12 +45,12 @@ public void Serialize(int networkId, ref GhostSnapshotData baseline, DataStreamW
         #endregion
     }
 
-    public void Deserialize(uint tick, ref GhostSnapshotData baseline, DataStreamReader reader, ref DataStreamReader.Context ctx,
+    public void Deserialize(uint tick, ref GhostSnapshotData baseline, ref DataStreamReader reader,
         NetworkCompressionModel compressionModel)
     {
         #region __GHOST_READ__
         if ((changeMask__GHOST_MASK_BATCH__ & (1 << __GHOST_MASK_INDEX__)) != 0)
-            __GHOST_FIELD_NAME__ = reader.ReadPackedUIntDelta(ref ctx, baseline.__GHOST_FIELD_NAME__, compressionModel);
+            __GHOST_FIELD_NAME__ = reader.ReadPackedUIntDelta(baseline.__GHOST_FIELD_NAME__, compressionModel);
         else
             __GHOST_FIELD_NAME__ = baseline.__GHOST_FIELD_NAME__;
         #endregion

Editor/CodeGenTemplates/SnapshotValue/GhostSnapshotValueEntity.cs

@@ -39,7 +39,7 @@ public void PredictDelta(uint tick, ref GhostSnapshotData baseline1, ref GhostSn
         #endregion
     }
 
-    public void Serialize(int networkId, ref GhostSnapshotData baseline, DataStreamWriter writer, NetworkCompressionModel compressionModel)
+    public void Serialize(int networkId, ref GhostSnapshotData baseline, ref DataStreamWriter writer, NetworkCompressionModel compressionModel)
     {
         #region __GHOST_CALCULATE_CHANGE_MASK_ZERO__
         changeMask__GHOST_MASK_BATCH__ = (__GHOST_FIELD_NAME__ != baseline.__GHOST_FIELD_NAME__) ? 1u : 0;
@@ -53,12 +53,12 @@ public void Serialize(int networkId, ref GhostSnapshotData baseline, DataStreamW
         #endregion
     }
 
-    public void Deserialize(uint tick, ref GhostSnapshotData baseline, DataStreamReader reader, ref DataStreamReader.Context ctx,
+    public void Deserialize(uint tick, ref GhostSnapshotData baseline, ref DataStreamReader reader,
         NetworkCompressionModel compressionModel)
     {
         #region __GHOST_READ__
         if ((changeMask__GHOST_MASK_BATCH__ & (1 << __GHOST_MASK_INDEX__)) != 0)
-            __GHOST_FIELD_NAME__ = reader.ReadPackedIntDelta(ref ctx, baseline.__GHOST_FIELD_NAME__, compressionModel);
+            __GHOST_FIELD_NAME__ = reader.ReadPackedIntDelta(baseline.__GHOST_FIELD_NAME__, compressionModel);
         else
             __GHOST_FIELD_NAME__ = baseline.__GHOST_FIELD_NAME__;
         #endregion

Editor/CodeGenTemplates/SnapshotValue/GhostSnapshotValueFloat.cs

@@ -31,7 +31,7 @@ public void PredictDelta(uint tick, ref GhostSnapshotData baseline1, ref GhostSn
         #endregion
     }
 
-    public void Serialize(int networkId, ref GhostSnapshotData baseline, DataStreamWriter writer, NetworkCompressionModel compressionModel)
+    public void Serialize(int networkId, ref GhostSnapshotData baseline, ref DataStreamWriter writer, NetworkCompressionModel compressionModel)
     {
         #region __GHOST_CALCULATE_CHANGE_MASK_ZERO__
         changeMask__GHOST_MASK_BATCH__ = (__GHOST_FIELD_NAME__ != baseline.__GHOST_FIELD_NAME__) ? 1u : 0;
@@ -45,12 +45,12 @@ public void Serialize(int networkId, ref GhostSnapshotData baseline, DataStreamW
         #endregion
     }
 
-    public void Deserialize(uint tick, ref GhostSnapshotData baseline, DataStreamReader reader, ref DataStreamReader.Context ctx,
+    public void Deserialize(uint tick, ref GhostSnapshotData baseline, ref DataStreamReader reader,
         NetworkCompressionModel compressionModel)
     {
         #region __GHOST_READ__
         if ((changeMask__GHOST_MASK_BATCH__ & (1 << __GHOST_MASK_INDEX__)) != 0)
-            __GHOST_FIELD_NAME__ = reader.ReadPackedIntDelta(ref ctx, baseline.__GHOST_FIELD_NAME__, compressionModel);
+            __GHOST_FIELD_NAME__ = reader.ReadPackedIntDelta(baseline.__GHOST_FIELD_NAME__, compressionModel);
         else
             __GHOST_FIELD_NAME__ = baseline.__GHOST_FIELD_NAME__;
         #endregion