Fast forward FPS project (#222)

Jamie Brynes · web-flow · commit 5f5ce845de0f · 2019-08-01T15:50:15.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,8 +2,24 @@
 
 ## Unreleased
 
+### Breaking Changes
+
+- The `AdvancedEntityPipeline` no longer takes an `IEntityGameObjectCreator` instance as a parameter when it is being constructed. [#222](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/222)
+    - Instead it instantiates an `GameObjectCreatorFromMetadata` as the fallback.
+    - This change was made as the `GameObjectCreatorFromMetadata` was being used at all call sites for the constructor.
+
+### Added
+
+- Added the `io.improbable.gdk.debug` package as a dependency. [#222](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/222)
+
+### Changed
+
+- The `AdvancedEntityPipeline` now uses the `OwningWorker` component from the PlayerLifecycle feature module [#222](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/222)
+- Removed the `DISABLE_REACTIVE_COMPONENTS` scripting define as it is no longer used. [#222](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/222)
+
 ### Fixed
 
+- Fixed a bug where the `SimulatedPlayerWorkerCoordinator` could throw a null reference exception once the worker had disconnected. [#222](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/222)
 - Fixed a bug where shooting a health pickup throws an exception. [#220](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/220)
 
 ## `0.2.5` - 2019-07-18
diff --git a/gdk.pinned b/gdk.pinned
@@ -1 +1 @@
-6689e300c017860a845fe5463b8a06b7caa1492b
+ec0f5ce719c2ba6db393d61d6d0fa4c6421b2bd6
diff --git a/spatialos.json b/spatialos.json
@@ -1,8 +1,8 @@
 {
     "name": "unity_gdk",
     "project_version": "0.0.1",
-    "sdk_version": "13.7.1-gdk-for-unity",
+    "sdk_version": "13.8.2",
     "dependencies": [
-        {"name": "standard_library", "version": "13.7.1-gdk-for-unity"}
+        {"name": "standard_library", "version": "13.8.2"}
     ]
 }
diff --git a/workers/unity/Assets/Fps/Scripts/SetupLogic/AdvancedEntityPipeline.cs b/workers/unity/Assets/Fps/Scripts/SetupLogic/AdvancedEntityPipeline.cs
@@ -4,6 +4,7 @@
 using Improbable.Gdk.Core;
 using Improbable.Gdk.GameObjectCreation;
 using Improbable.Gdk.Movement;
+using Improbable.Gdk.PlayerLifecycle;
 using Improbable.Gdk.StandardTypes;
 using Improbable.Gdk.Subscriptions;
 using UnityEngine;
@@ -13,16 +14,16 @@ namespace Fps
 {
     public class AdvancedEntityPipeline : IEntityGameObjectCreator
     {
-        private const string GameobjectNameFormat = "{0}(SpatialOS {1}, Worker: {2})";
-        private const string WorkerAttributeFormat = "workerId:{0}";
-        private const string PlayerMetadata = "Player";
+        private const string PlayerEntityType = "Player";
 
         private readonly GameObject cachedAuthPlayer;
         private readonly GameObject cachedNonAuthPlayer;
 
-        private readonly IEntityGameObjectCreator fallback;
-        private readonly string workerIdAttribute;
-        private readonly WorkerInWorld worker;
+        private readonly GameObjectCreatorFromMetadata fallback;
+
+        private readonly string workerId;
+        private readonly string workerType;
+        private readonly Vector3 workerOrigin;
 
         private readonly Dictionary<EntityId, GameObject> gameObjectsCreated = new Dictionary<EntityId, GameObject>();
 
@@ -34,58 +35,49 @@ public class AdvancedEntityPipeline : IEntityGameObjectCreator
             typeof(Rigidbody)
         };
 
-        public AdvancedEntityPipeline(WorkerInWorld worker, string authPlayer, string nonAuthPlayer,
-            IEntityGameObjectCreator fallback)
+        public AdvancedEntityPipeline(WorkerInWorld worker, string authPlayer, string nonAuthPlayer)
         {
-            this.worker = worker;
-            this.fallback = fallback;
-            workerIdAttribute = EntityTemplate.GetWorkerAccessAttribute(worker.WorkerId);
+            workerId = worker.WorkerId;
+            workerType = worker.WorkerType;
+            workerOrigin = worker.Origin;
+
+            fallback = new GameObjectCreatorFromMetadata(workerType, workerOrigin, worker.LogDispatcher);
             cachedAuthPlayer = Resources.Load<GameObject>(authPlayer);
             cachedNonAuthPlayer = Resources.Load<GameObject>(nonAuthPlayer);
         }
 
         public void OnEntityCreated(SpatialOSEntity entity, EntityGameObjectLinker linker)
         {
-            if (!entity.HasComponent<Metadata.Component>())
+            if (!entity.TryGetComponent<Metadata.Component>(out var metadata))
             {
                 return;
             }
 
-            var prefabName = entity.GetComponent<Metadata.Component>().EntityType;
-            if (prefabName.Equals(PlayerMetadata))
+            if (metadata.EntityType == PlayerEntityType)
             {
-                var clientMovement = entity.GetComponent<ClientMovement.Component>();
-                if (entity.GetComponent<EntityAcl.Component>().ComponentWriteAcl
-                    .TryGetValue(clientMovement.ComponentId, out var clientMovementWrite))
-                {
-                    var authority = false;
-                    foreach (var attributeSet in clientMovementWrite.AttributeSet)
-                    {
-                        if (attributeSet.Attribute.Contains(workerIdAttribute))
-                        {
-                            authority = true;
-                        }
-                    }
-
-                    var serverPosition = entity.GetComponent<ServerMovement.Component>();
-                    var position = serverPosition.Latest.Position.ToVector3() + worker.Origin;
-
-                    var prefab = authority ? cachedAuthPlayer : cachedNonAuthPlayer;
-                    var gameObject = Object.Instantiate(prefab, position, Quaternion.identity);
-
-                    gameObjectsCreated.Add(entity.SpatialOSEntityId, gameObject);
-                    gameObject.name = GetGameObjectName(prefab, entity, worker);
-                    linker.LinkGameObjectToSpatialOSEntity(entity.SpatialOSEntityId, gameObject, componentsToAdd);
-                    return;
-                }
+                CreatePlayerGameObject(entity, linker);
+                return;
             }
 
             fallback.OnEntityCreated(entity, linker);
         }
 
-        private static string GetGameObjectName(GameObject prefab, SpatialOSEntity entity, Worker worker)
+        private void CreatePlayerGameObject(SpatialOSEntity entity, EntityGameObjectLinker linker)
         {
-            return string.Format(GameobjectNameFormat, prefab.name, entity.SpatialOSEntityId, worker.WorkerType);
+            if (!entity.TryGetComponent<OwningWorker.Component>(out var owningWorker))
+            {
+                throw new InvalidOperationException("Player entity does not have the OwningWorker component");
+            }
+
+            var serverPosition = entity.GetComponent<ServerMovement.Component>();
+            var position = serverPosition.Latest.Position.ToVector3() + workerOrigin;
+
+            var prefab = owningWorker.WorkerId == workerId ? cachedAuthPlayer : cachedNonAuthPlayer;
+            var gameObject = Object.Instantiate(prefab, position, Quaternion.identity);
+
+            gameObjectsCreated.Add(entity.SpatialOSEntityId, gameObject);
+            gameObject.name = $"{prefab.name}(SpatialOS {entity.SpatialOSEntityId}, Worker: {workerType})";
+            linker.LinkGameObjectToSpatialOSEntity(entity.SpatialOSEntityId, gameObject, componentsToAdd);
         }
 
         public void OnEntityRemoved(EntityId entityId)
diff --git a/workers/unity/Assets/Fps/Scripts/SetupLogic/ClientWorkerConnector.cs b/workers/unity/Assets/Fps/Scripts/SetupLogic/ClientWorkerConnector.cs
@@ -109,10 +109,7 @@ protected override void HandleWorkerConnectionEstablished()
             PlayerLifecycleHelper.AddClientSystems(world, autoRequestPlayerCreation: false);
             PlayerLifecycleConfig.MaxPlayerCreationRetries = 0;
 
-            var fallback = new GameObjectCreatorFromMetadata(Worker.WorkerType, Worker.Origin, Worker.LogDispatcher);
-
-            entityPipeline = new AdvancedEntityPipeline(Worker, GetAuthPlayerPrefabPath(),
-                GetNonAuthPlayerPrefabPath(), fallback);
+            entityPipeline = new AdvancedEntityPipeline(Worker, GetAuthPlayerPrefabPath(), GetNonAuthPlayerPrefabPath());
             entityPipeline.OnRemovedAuthoritativePlayer += RemovingAuthoritativePlayer;
 
             // Set the Worker gameObject to the ClientWorker so it can access PlayerCreater reader/writers
diff --git a/workers/unity/Assets/Fps/Scripts/SetupLogic/SimulatedPlayerCoordinatorWorkerConnector.cs b/workers/unity/Assets/Fps/Scripts/SetupLogic/SimulatedPlayerCoordinatorWorkerConnector.cs
@@ -201,7 +201,7 @@ private async Task Monitor(int count, int interval, Func<SimulatedPlayerWorkerCo
         {
             var token = tokenSource.Token;
 
-            while (Worker.IsConnected)
+            while (Worker != null && Worker.IsConnected)
             {
                 if (token.IsCancellationRequested)
                 {
diff --git a/workers/unity/Assets/Fps/Scripts/SetupLogic/SimulatedPlayerWorkerConnector.cs b/workers/unity/Assets/Fps/Scripts/SetupLogic/SimulatedPlayerWorkerConnector.cs
@@ -56,12 +56,8 @@ protected override void HandleWorkerConnectionEstablished()
         {
             PlayerLifecycleHelper.AddClientSystems(Worker.World, false);
 
-            var fallback = new GameObjectCreatorFromMetadata(Worker.WorkerType,
-                Worker.Origin, Worker.LogDispatcher);
-
-            GameObjectCreationHelper.EnableStandardGameObjectCreation(
-                Worker.World,
-                new AdvancedEntityPipeline(Worker, AuthPlayer, NonAuthPlayer, fallback));
+            GameObjectCreationHelper.EnableStandardGameObjectCreation(Worker.World,
+                new AdvancedEntityPipeline(Worker, AuthPlayer, NonAuthPlayer));
         }
     }
 }
diff --git a/workers/unity/Packages/.gitignore b/workers/unity/Packages/.gitignore
@@ -1,5 +1,6 @@
 io.improbable.gdk.buildsystem
 io.improbable.gdk.core
+io.improbable.gdk.debug
 io.improbable.gdk.deploymentlauncher
 io.improbable.gdk.gameobjectcreation
 io.improbable.gdk.mobile
diff --git a/workers/unity/Packages/manifest.json b/workers/unity/Packages/manifest.json
@@ -2,6 +2,7 @@
   "dependencies": {
     "io.improbable.gdk.buildsystem": "0.2.5",
     "io.improbable.gdk.core": "0.2.5",
+    "io.improbable.gdk.debug": "0.2.5",
     "io.improbable.gdk.deploymentlauncher": "0.2.5",
     "io.improbable.gdk.deploymentmanager": "file:io.improbable.gdk.deploymentmanager",
     "io.improbable.gdk.gameobjectcreation": "0.2.5",
diff --git a/workers/unity/ProjectSettings/ProjectSettings.asset b/workers/unity/ProjectSettings/ProjectSettings.asset
@@ -621,9 +621,9 @@ PlayerSettings:
   webGLThreadsSupport: 0
   webGLWasmStreaming: 0
   scriptingDefineSymbols:
-    1: UNITY_POST_PROCESSING_STACK_V2;UNITY_DISABLE_AUTOMATIC_SYSTEM_BOOTSTRAP;DISABLE_REACTIVE_COMPONENTS
-    4: UNITY_POST_PROCESSING_STACK_V2;UNITY_DISABLE_AUTOMATIC_SYSTEM_BOOTSTRAP;DISABLE_REACTIVE_COMPONENTS
-    7: UNITY_POST_PROCESSING_STACK_V2;UNITY_DISABLE_AUTOMATIC_SYSTEM_BOOTSTRAP;DISABLE_REACTIVE_COMPONENTS
+    1: UNITY_POST_PROCESSING_STACK_V2;UNITY_DISABLE_AUTOMATIC_SYSTEM_BOOTSTRAP
+    4: UNITY_POST_PROCESSING_STACK_V2;UNITY_DISABLE_AUTOMATIC_SYSTEM_BOOTSTRAP
+    7: UNITY_POST_PROCESSING_STACK_V2;UNITY_DISABLE_AUTOMATIC_SYSTEM_BOOTSTRAP
     13: UNITY_POST_PROCESSING_STACK_V2
     14: UNITY_POST_PROCESSING_STACK_V2
     17: UNITY_POST_PROCESSING_STACK_V2

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-6689e300c017860a845fe5463b8a06b7caa1492b`
	`1`	`+ec0f5ce719c2ba6db393d61d6d0fa4c6421b2bd6`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "unity_gdk",`
`3`	`3`	`"project_version": "0.0.1",`
`4`		`- "sdk_version": "13.7.1-gdk-for-unity",`
	`4`	`+ "sdk_version": "13.8.2",`
`5`	`5`	`"dependencies": [`
`6`		`- {"name": "standard_library", "version": "13.7.1-gdk-for-unity"}`
	`6`	`+ {"name": "standard_library", "version": "13.8.2"}`
`7`	`7`	`]`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ private async Task Monitor(int count, int interval, Func<SimulatedPlayerWorkerCo`
`201`	`201`	`{`
`202`	`202`	`var token = tokenSource.Token;`
`203`	`203`
`204`		`- while (Worker.IsConnected)`
	`204`	`+ while (Worker != null && Worker.IsConnected)`
`205`	`205`	`{`
`206`	`206`	`if (token.IsCancellationRequested)`
`207`	`207`	`{`
Original file line number	Diff line number	Diff line change
`@@ -56,12 +56,8 @@ protected override void HandleWorkerConnectionEstablished()`
`56`	`56`	`{`
`57`	`57`	`PlayerLifecycleHelper.AddClientSystems(Worker.World, false);`
`58`	`58`
`59`		`- var fallback = new GameObjectCreatorFromMetadata(Worker.WorkerType,`
`60`		`- Worker.Origin, Worker.LogDispatcher);`
`61`		`-`
`62`		`- GameObjectCreationHelper.EnableStandardGameObjectCreation(`
`63`		`- Worker.World,`
`64`		`- new AdvancedEntityPipeline(Worker, AuthPlayer, NonAuthPlayer, fallback));`
	`59`	`+ GameObjectCreationHelper.EnableStandardGameObjectCreation(Worker.World,`
	`60`	`+ new AdvancedEntityPipeline(Worker, AuthPlayer, NonAuthPlayer));`
`65`	`61`	`}`
`66`	`62`	`}`
`67`	`63`	`}`