PlayerLifecycle integration with the EntityReservationSystem

CHANGELOG.md

@@ -8,6 +8,8 @@
 - Schema components in ECS no longer have a `ComponentId` property. [#1308](https://github.com/spatialos/gdk-for-unity/pull/1308)
     - You should use `ComponentDatabase.GetComponentId<T>()` instead.
 - `CustomSpatialOSSendSystem` is no longer available. [#1308](https://github.com/spatialos/gdk-for-unity/pull/1308)
+- The PlayerLifecycle feature module now provides an `EntityId` in it's CreatePlayerEntityTemplate callback. [#1315](https://github.com/spatialos/gdk-for-unity/pull/1315)
+    - You will have to change your callback from `(string clientWorkerId, byte[] serializedArguments)` to `(EntityId entityId, string clientWorkerId, byte[] serializedArguments)`.
 
 ### Added
 

UPGRADE_GUIDE.md

@@ -1,5 +1,34 @@
 # Upgrade Guide
 
+## From `0.3.3` to `0.3.4`
+
+### PlayerLifecycle feature module now provides an EntityId
+
+The callback used for creating a player `EntityTemplate` has changed to provide an `EntityId` up front.
+This will be the `EntityId` the player's Entity will have after it is successfully spawned, and can be usefull for QBI.
+
+```csharp
+// Previously
+public static EntityTemplate Player(string workerId, byte[] args)
+{
+    var template = new EntityTemplate();
+    // ...
+    return template;
+}
+
+PlayerLifecycleConfig.CreatePlayerEntityTemplate = FpsEntityTemplates.Player;
+
+// Now
+public static EntityTemplate Player(EntityId entityId, string workerId, byte[] args)
+{
+    var template = new EntityTemplate();
+    // ...
+    return template;
+}
+
+PlayerLifecycleConfig.CreatePlayerEntityTemplate = FpsEntityTemplates.Player;
+```
+
 ## From `0.3.2` to `0.3.3`
 
 ### Building for Android now requires the NDK

workers/unity/Assets/Playground/Config/PlayerTemplate.cs

@@ -9,7 +9,7 @@ namespace Playground
 {
     public static class PlayerTemplate
     {
-        public static EntityTemplate CreatePlayerEntityTemplate(string clientWorkerId, byte[] playerCreationArguments)
+        public static EntityTemplate CreatePlayerEntityTemplate(EntityId entityId, string clientWorkerId, byte[] playerCreationArguments)
         {
             var clientAttribute = EntityTemplate.GetWorkerAccessAttribute(clientWorkerId);
 

workers/unity/Assets/Playground/Config/WorkerUtils.cs

@@ -36,7 +36,6 @@ public static void AddGameLogicSystems(World world)
             PlayerLifecycleHelper.AddServerSystems(world);
             GameObjectCreationHelper.EnableStandardGameObjectCreation(world);
 
-            world.GetOrCreateSystem<EntityReservationSystem>();
             world.GetOrCreateSystem<TriggerColorChangeSystem>();
             world.GetOrCreateSystem<ProcessLaunchCommandSystem>();
             world.GetOrCreateSystem<ProcessRechargeSystem>();

workers/unity/Packages/io.improbable.gdk.playerlifecycle/Config/PlayerLifecycleConfig.cs

@@ -20,6 +20,7 @@ namespace Improbable.Gdk.PlayerLifecycle
     ///     An <see cref="EntityTemplate"/> to create a SpatialOS player entity from.
     /// </returns>
     public delegate EntityTemplate GetPlayerEntityTemplateDelegate(
+        EntityId entityId,
         string clientWorkerId,
         byte[] serializedArguments);
 

workers/unity/Packages/io.improbable.gdk.playerlifecycle/PlayerLifecycleHelper.cs

@@ -65,6 +65,7 @@ public static void AddClientSystems(World world, bool autoRequestPlayerCreation
         /// <param name="world">A world that belongs to a server-worker.</param>
         public static void AddServerSystems(World world)
         {
+            world.GetOrCreateSystem<EntityReservationSystem>();
             world.GetOrCreateSystem<HandleCreatePlayerRequestSystem>();
             world.GetOrCreateSystem<PlayerHeartbeatInitializationSystem>();
             world.GetOrCreateSystem<SendPlayerHeartbeatRequestSystem>();

workers/unity/Packages/io.improbable.gdk.playerlifecycle/Systems/PlayerCreation/HandleCreatePlayerRequestSystem.cs

@@ -11,11 +11,13 @@ namespace Improbable.Gdk.PlayerLifecycle
     public class HandleCreatePlayerRequestSystem : ComponentSystem
     {
         private CommandSystem commandSystem;
+        private EntityReservationSystem entityReservationSystem;
 
         protected override void OnCreate()
         {
             base.OnCreate();
             commandSystem = World.GetExistingSystem<CommandSystem>();
+            entityReservationSystem = World.GetOrCreateSystem<EntityReservationSystem>();
         }
 
         private class PlayerCreationRequestContext
@@ -40,24 +42,34 @@ private void HandlePlayerCreateRequests()
             for (var i = 0; i < requests.Count; ++i)
             {
                 ref readonly var request = ref requests[i];
-                var playerEntityTemplate = PlayerLifecycleConfig.CreatePlayerEntityTemplate(
-                    request.CallerWorkerId,
-                    request.Payload.SerializedArguments
-                );
 
-                var entityRequest = new WorldCommands.CreateEntity.Request
-                (
-                    playerEntityTemplate,
-                    context: new PlayerCreationRequestContext
-                    {
-                        createPlayerRequest = request
-                    }
-                );
-
-                commandSystem.SendCommand(entityRequest);
+                SpawnPlayerEntity(request);
             }
         }
 
+        private async void SpawnPlayerEntity(PlayerCreator.CreatePlayer.ReceivedRequest receivedRequest)
+        {
+            var entityId = await entityReservationSystem.GetAsync();
+
+            var playerEntityTemplate = PlayerLifecycleConfig.CreatePlayerEntityTemplate(
+                entityId,
+                receivedRequest.CallerWorkerId,
+                receivedRequest.Payload.SerializedArguments
+            );
+
+            var entityRequest = new WorldCommands.CreateEntity.Request
+            (
+                playerEntityTemplate,
+                entityId,
+                context: new PlayerCreationRequestContext
+                {
+                    createPlayerRequest = receivedRequest
+                }
+            );
+
+            commandSystem.SendCommand(entityRequest);
+        }
+
         private void HandlePlayerCreateEntityResponses()
         {
             var responses = commandSystem.GetResponses<WorldCommands.CreateEntity.ReceivedResponse>();