QBI query component filtering (#264)

Author: Paul Balaji

CHANGELOG.md

@@ -6,6 +6,14 @@
 
 - The FPS Starter Project now requires Unity 2019.3. [#263](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/263)
 
+## Added
+
+- Added component result type filters to QBI queries. [#264](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/264)
+
+## Changed
+
+- Updated project to support `com.unity.entities` package upgrade. [#264](https://github.com/spatialos/gdk-for-unity-fps-starter-project/pull/264)
+
 ## `0.3.4` - 2020-03-25
 
 ## Breaking Changes

gdk.pinned

@@ -1 +1 @@
-develop 79dc4b1c77fdf58ba082dc448d6519462cec7159
+develop b03b2129f9c2fccc7058f49fbf3a89c61376a881

snapshots/cloud.snapshot

@@ -22,14 +22,6 @@ public static EntityTemplate Spawner(Coordinates spawnerCoordinates)
             template.AddComponent(new Persistence.Snapshot(), WorkerUtils.UnityGameLogic);
             template.AddComponent(new PlayerCreator.Snapshot(), WorkerUtils.UnityGameLogic);
 
-            var query = InterestQuery.Query(Constraint.RelativeCylinder(150));
-            var interest = InterestTemplate.Create()
-                .AddQueries<Position.Component>(query);
-            template.AddComponent(interest.ToSnapshot(), WorkerUtils.UnityGameLogic);
-
-            template.SetReadAccess(WorkerUtils.UnityGameLogic);
-            template.SetComponentWriteAccess(EntityAcl.ComponentId, WorkerUtils.UnityGameLogic);
-
             return template;
         }
 
@@ -90,16 +82,51 @@ public static EntityTemplate Player(EntityId entityId, string workerId, byte[] a
             const int serverRadius = 150;
             var clientRadius = workerId.Contains(WorkerUtils.MobileClient) ? 60 : 150;
 
-            var serverQuery = InterestQuery.Query(Constraint.RelativeCylinder(serverRadius));
-            var clientQuery = InterestQuery.Query(Constraint.RelativeCylinder(clientRadius));
+            // Position, Metadata, OwningWorker and ServerMovement are included in all queries, since these
+            // components are required by the GameObject creator.
+
+            // HealthComponent is needed by the LookAtRagdoll script for respawn behaviour.
+            // GunComponent is needed by the GunManager script.
+            var clientSelfInterest = InterestQuery.Query(Constraint.EntityId(entityId)).FilterResults(new[]
+            {
+                Position.ComponentId, Metadata.ComponentId, OwningWorker.ComponentId,
+                ServerMovement.ComponentId, HealthComponent.ComponentId, GunComponent.ComponentId
+            });
+
+            // ClientRotation is used for rendering other players.
+            // GunComponent is required by the GunManager script.
+            // GunStateComponent and ShootingComponent are needed for rendering other players' shots.
+            var clientRangeInterest = InterestQuery.Query(Constraint.RelativeCylinder(clientRadius)).FilterResults(new[]
+            {
+                Position.ComponentId, Metadata.ComponentId, OwningWorker.ComponentId,
+                ServerMovement.ComponentId, ClientRotation.ComponentId, HealthComponent.ComponentId,
+                GunComponent.ComponentId, GunStateComponent.ComponentId, ShootingComponent.ComponentId
+            });
+
+            // ClientMovement is used by the ServerMovementDriver script.
+            // ShootingComponent is used by the ServerShootingSystem.
+            var serverSelfInterest = InterestQuery.Query(Constraint.EntityId(entityId)).FilterResults(new[]
+            {
+                ClientMovement.ComponentId, ShootingComponent.ComponentId
+            });
+
+            // ClientRotation is used for driving player proxies.
+            // HealthComponent is required by the VisiblityAndCollision script.
+            // ShootingComponent is used by the ServerShootingSystem.
+            var serverRangeInterest = InterestQuery.Query(Constraint.RelativeCylinder(serverRadius)).FilterResults(new[]
+            {
+                Position.ComponentId, Metadata.ComponentId, OwningWorker.ComponentId,
+                ServerMovement.ComponentId, ClientRotation.ComponentId, HealthComponent.ComponentId,
+                ShootingComponent.ComponentId
+            });
 
             var interest = InterestTemplate.Create()
-                .AddQueries<Position.Component>(serverQuery)
-                .AddQueries<ClientMovement.Component>(clientQuery);
-            template.AddComponent(interest.ToSnapshot(), WorkerUtils.UnityGameLogic);
+                .AddQueries<ClientMovement.Component>(clientSelfInterest, clientRangeInterest)
+                .AddQueries<ServerMovement.Component>(serverSelfInterest, serverRangeInterest);
+
+            template.AddComponent(interest.ToSnapshot());
 
             template.SetReadAccess(WorkerUtils.UnityClient, WorkerUtils.UnityGameLogic, WorkerUtils.MobileClient);
-            template.SetComponentWriteAccess(EntityAcl.ComponentId, WorkerUtils.UnityGameLogic);
 
             return template;
         }

snapshots/default.snapshot

@@ -18,7 +18,6 @@ private static void Init()
             }
 
             initialized = true;
-            PlayerLoopManager.RegisterDomainUnload(WorldsInitializationHelper.DomainUnloadShutdown, 1000);
 
             // Setup template to use for player on connecting client
             PlayerLifecycleConfig.CreatePlayerEntityTemplate = FpsEntityTemplates.Player;

workers/unity/Assets/Fps/Scripts/Config/FpsEntityTemplates.cs

@@ -33,18 +33,16 @@ protected override void OnCreate()
             initGroup = GetEntityQuery(
                 ComponentType.ReadOnly<HealthRegenComponent.Component>(),
                 ComponentType.Exclude<HealthRegenData>(),
-                ComponentType.ReadOnly<HealthComponent.ComponentAuthority>()
+                ComponentType.ReadOnly<HealthComponent.HasAuthority>()
             );
-            initGroup.SetFilter(HealthComponent.ComponentAuthority.Authoritative);
 
             regenGroup = GetEntityQuery(
                 ComponentType.ReadWrite<HealthRegenComponent.Component>(),
                 ComponentType.ReadWrite<HealthRegenData>(),
                 ComponentType.ReadOnly<HealthComponent.Component>(),
                 ComponentType.ReadOnly<SpatialEntityId>(),
-                ComponentType.ReadOnly<HealthComponent.ComponentAuthority>()
+                ComponentType.ReadOnly<HealthComponent.HasAuthority>()
             );
-            regenGroup.SetFilter(HealthComponent.ComponentAuthority.Authoritative);
         }
 
         protected override void OnUpdate()
@@ -142,7 +140,7 @@ private void ApplyHealthRegen()
                     // If damaged recently, tick down the timer.
                     if (regenComponent.DamagedRecently)
                     {
-                        regenData.DamagedRecentlyTimer -= Time.deltaTime;
+                        regenData.DamagedRecentlyTimer -= Time.DeltaTime;
 
                         if (regenData.DamagedRecentlyTimer <= 0)
                         {
@@ -153,7 +151,7 @@ private void ApplyHealthRegen()
                         else
                         {
                             // Send a spatial update once every CooldownSyncInterval.
-                            regenData.NextSpatialSyncTimer -= Time.deltaTime;
+                            regenData.NextSpatialSyncTimer -= Time.DeltaTime;
                             if (regenData.NextSpatialSyncTimer <= 0)
                             {
                                 regenData.NextSpatialSyncTimer += regenComponent.CooldownSyncInterval;
@@ -167,7 +165,7 @@ private void ApplyHealthRegen()
                     // If not damaged recently, and not already fully healed, regen.
                     if (healthComponent.Health < healthComponent.MaxHealth)
                     {
-                        regenData.NextRegenTimer -= Time.deltaTime;
+                        regenData.NextRegenTimer -= Time.DeltaTime;
                         if (regenData.NextRegenTimer <= 0)
                         {
                             regenData.NextRegenTimer += regenComponent.RegenInterval;

workers/unity/Assets/Fps/Scripts/Config/OneTimeInitialisation.cs

@@ -36,7 +36,7 @@ protected override void OnCreate()
                 ? DefaultTargetFrameRate
                 : Application.targetFrameRate;
 
-            lastFrameCount = Time.frameCount;
+            lastFrameCount = UnityEngine.Time.frameCount;
             calculatedFps = targetFps;
 
             timeOfLastUpdate = DateTime.Now;
@@ -69,8 +69,8 @@ private double CalculateLoad()
 
         private void CalculateFps()
         {
-            var frameCount = Time.frameCount - lastFrameCount;
-            lastFrameCount = Time.frameCount;
+            var frameCount = UnityEngine.Time.frameCount - lastFrameCount;
+            lastFrameCount = UnityEngine.Time.frameCount;
             var rawFps = frameCount / (DateTime.Now - timeOfLastUpdate).TotalSeconds;
             calculatedFps = (rawFps * (1 - smoothing)) + (calculatedFps * smoothing);
         }