firefighters tutorial step 4: animation and UI

Author: BrianWill-Unity

EntitiesSamples/Assets/Miscellaneous/AnimateGameObject/SpawnSystem.cs

@@ -1,9 +1,7 @@
-using System;
 using Unity.Burst;
 using Unity.Collections;
 using Unity.Entities;
 using UnityEngine;
-using Object = UnityEngine.Object;
 
 namespace Miscellaneous.AnimationWithGameObjects
 {

EntitiesSamples/Assets/Tutorials/Firefighters/Common/Bot.prefab

@@ -60,9 +60,6 @@ MeshRenderer:
   m_ReflectionProbeUsage: 1
   m_RayTracingMode: 2
   m_RayTraceProcedural: 0
-  m_RayTracingAccelStructBuildFlagsOverride: 0
-  m_RayTracingAccelStructBuildFlags: 1
-  m_SmallMeshCulling: 1
   m_RenderingLayerMask: 1
   m_RendererPriority: 0
   m_Materials:

EntitiesSamples/Assets/Tutorials/Firefighters/Common/Config.prefab

@@ -88,3 +88,5 @@ MonoBehaviour:
     type: 3}
   GroundCellPrefab: {fileID: 3422103013957337004, guid: 0142cf2bddc0e2f448344a8fb2222b4c,
     type: 3}
+  BotAnimatedPrefabGO: {fileID: 5701704621631426976, guid: 36e93c435d1648a4c86d516057a9cbe2,
+    type: 3}

EntitiesSamples/Assets/Tutorials/Firefighters/Common/ExecuteAuthoring.cs

@@ -9,7 +9,9 @@ public class ExecuteAuthoring : MonoBehaviour
         public bool ExecuteBotSystem;
         public bool ExecuteBucketSystem;
         public bool ExecuteTeamSystem;
-
+        public bool ExecuteUISystem;
+        public bool ExecuteAnimationSystem;
+        
         class Baker : Baker<ExecuteAuthoring>
         {
             public override void Bake(ExecuteAuthoring authoring)
@@ -34,6 +36,16 @@ public override void Bake(ExecuteAuthoring authoring)
                 {
                     AddComponent<ExecuteTeam>(entity);
                 }
+                
+                if (authoring.ExecuteUISystem)
+                {
+                    AddComponent<ExecuteUI>(entity);
+                }
+                
+                if (authoring.ExecuteAnimationSystem)
+                {
+                    AddComponent<ExecuteAnimation>(entity);
+                }
             }
         }
     }
@@ -53,4 +65,12 @@ public struct ExecuteBucket : IComponentData
     public struct ExecuteTeam : IComponentData
     {
     }
+    
+    public struct ExecuteUI : IComponentData
+    {
+    }
+    
+    public struct ExecuteAnimation : IComponentData
+    {
+    }
 }

EntitiesSamples/Assets/Tutorials/Firefighters/Common/firefighters.png.meta

@@ -18,4 +18,8 @@ This step adds code to spread the fire. Three solutions are demonstrated:
 
 # Step 3: Bot behaviour
 
-This step adds behiour to the bots, who are organized into teams. Each team forms a line between a pond and the closest fire. A bucket is filled at the pond and then passed up the line.
+This step adds behiour to the bots, who are organized into teams. Each team forms a line between a pond and the closest fire. A bucket is filled at the pond and then passed up the line.
+
+# Step 4: Animation and UI
+
+This step replaces the bot capsules with animated characters. A UI HUD element displays the total count of fires that have been doused.

EntitiesSamples/Assets/Tutorials/Firefighters/README.md

@@ -28,6 +28,14 @@ public struct Bot : IComponentData
         public Entity Bucket;      // The bucket that the bot is carrying.
         public bool IsCarrying;    // True if carrying a bucket.
         public Entity Team;        // The team to which the bot belongs.
+
+        public readonly bool IsMoving()
+        {
+            return !(State == BotState.IDLE
+                     || State == BotState.CLAIM_BUCKET
+                     || State == BotState.WAIT_IN_LINE
+                     || State == BotState.FILL_BUCKET);
+        }
     }
 
     public enum BotState

EntitiesSamples/Assets/Tutorials/Firefighters/README.md.meta

@@ -1,4 +1,5 @@
 using Unity.Entities;
+using UnityEngine;
 
 namespace Tutorials.Firefighters
 {
@@ -7,6 +8,7 @@ public struct Team : IComponentData
         public Entity Filler;
         public Entity Douser;
         public bool HasBucket;
+        public int NumFiresDoused;
     }
 
     // all bots in the team (including the Filler and Douser) in order of passing, starting with the Filler
@@ -24,4 +26,9 @@ public struct Heat : IBufferElementData
     {
         public float Value;
     }
+    
+    public class BotAnimation : IComponentData
+    {
+        public GameObject AnimatedGO;   // the GO that is rendered and animated
+    }
 }

EntitiesSamples/Assets/Tutorials/Firefighters/Step 1/BotAuthoring.cs

@@ -41,6 +41,7 @@ public class ConfigAuthoring : MonoBehaviour
         public GameObject BucketPrefab;
         public GameObject PondPrefab;
         public GameObject GroundCellPrefab;
+        public GameObject BotAnimatedPrefabGO;
 
         class Baker : Baker<ConfigAuthoring>
         {
@@ -76,6 +77,9 @@ public override void Bake(ConfigAuthoring authoring)
                     PondPrefab = GetEntity(authoring.PondPrefab, TransformUsageFlags.Dynamic),
                     GroundCellPrefab = GetEntity(authoring.GroundCellPrefab, TransformUsageFlags.Dynamic),
                 });
+                var configManaged = new ConfigManaged();
+                configManaged.BotAnimatedPrefabGO = authoring.BotAnimatedPrefabGO;
+                AddComponentObject(entity, configManaged);
             }
         }
     }
@@ -110,4 +114,10 @@ public struct Config : IComponentData
         public Entity PondPrefab;
         public Entity GroundCellPrefab;
     }
+
+    public class ConfigManaged : IComponentData
+    {
+        public GameObject BotAnimatedPrefabGO;
+        public UIController UIController;
+    }
 }

EntitiesSamples/Assets/Tutorials/Firefighters/Step 1/Components.cs

@@ -2,6 +2,8 @@
 using Unity.Entities;
 using Unity.Mathematics;
 using Unity.Transforms;
+using Unity.VisualScripting;
+using UnityEngine;
 
 namespace Tutorials.Firefighters
 {
@@ -105,6 +107,8 @@ private void BotUpdate_MainThread(ref SystemState state, DynamicBuffer<Heat> hea
                             HeatSystem.DouseFire(bot.ValueRO.TargetPos, heatBuffer, numRows, numCols);
 
                             SystemAPI.SetComponentEnabled<RepositionLine>(bot.ValueRO.Team, true);
+                            var team = SystemAPI.GetComponentRW<Team>(bot.ValueRO.Team);
+                            team.ValueRW.NumFiresDoused++;
 
                             bot.ValueRW.State = BotState.MOVE_TO_LINE;
                         }
@@ -189,7 +193,16 @@ private static bool MoveToTarget(ref LocalTransform botTrans, float2 targetPos,
         {
             var pos = botTrans.Position;
             var dir = targetPos - pos.xz;
-            var moveVector = math.normalizesafe(dir) * moveSpeed;
+            var moveVectorNormalized = math.normalizesafe(dir);
+            var moveVector = moveVectorNormalized * moveSpeed;
+            
+            // The the animated model faces up the z axis, so we need to rotate it 90 degrees clockwise.
+            var modelRotation = math.radians(90);
+            
+            // atan2 returns a counter-clockwise angle of rotation, so we negate to make it clockwise
+            var facingRotation = -math.atan2(moveVectorNormalized.y, moveVectorNormalized.x);   
+            
+            botTrans.Rotation = quaternion.RotateY(modelRotation + facingRotation);
 
             if (math.lengthsq(moveVector) >= math.lengthsq(dir))
             {

EntitiesSamples/Assets/Tutorials/Firefighters/Step 1/ConfigAuthoring.cs

@@ -13,7 +13,7 @@ OcclusionCullingSettings:
 --- !u!104 &2
 RenderSettings:
   m_ObjectHideFlags: 0
-  serializedVersion: 10
+  serializedVersion: 9
   m_Fog: 0
   m_FogColor: {r: 0.5, g: 0.5, b: 0.5, a: 1}
   m_FogMode: 3
@@ -44,6 +44,7 @@ RenderSettings:
 LightmapSettings:
   m_ObjectHideFlags: 0
   serializedVersion: 12
+  m_GIWorkflowMode: 1
   m_GISettings:
     serializedVersion: 2
     m_BounceScale: 1
@@ -66,6 +67,9 @@ LightmapSettings:
     m_LightmapParameters: {fileID: 0}
     m_LightmapsBakeMode: 1
     m_TextureCompression: 1
+    m_FinalGather: 0
+    m_FinalGatherFiltering: 1
+    m_FinalGatherRayCount: 256
     m_ReflectionCompression: 2
     m_MixedBakeMode: 2
     m_BakeBackend: 1
@@ -129,6 +133,7 @@ GameObject:
   m_Component:
   - component: {fileID: 776551999}
   - component: {fileID: 776551998}
+  - component: {fileID: 776552000}
   m_Layer: 0
   m_Name: Directional Light
   m_TagString: Untagged
@@ -144,8 +149,9 @@ Light:
   m_PrefabAsset: {fileID: 0}
   m_GameObject: {fileID: 776551997}
   m_Enabled: 1
-  serializedVersion: 11
+  serializedVersion: 10
   m_Type: 1
+  m_Shape: 0
   m_Color: {r: 1, g: 0.95686275, b: 0.8392157, a: 1}
   m_Intensity: 1
   m_Range: 10
@@ -195,7 +201,6 @@ Light:
   m_BoundingSphereOverride: {x: 0, y: 0, z: 0, w: 0}
   m_UseBoundingSphereOverride: 0
   m_UseViewFrustumForShadowCasterCull: 1
-  m_ForceVisible: 0
   m_ShadowRadius: 0
   m_ShadowAngle: 0
 --- !u!4 &776551999
@@ -213,6 +218,29 @@ Transform:
   m_Children: []
   m_Father: {fileID: 0}
   m_LocalEulerAnglesHint: {x: 50, y: -30, z: 0}
+--- !u!114 &776552000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 776551997}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 474bcb49853aa07438625e644c072ee6, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  m_Version: 3
+  m_UsePipelineSettings: 1
+  m_AdditionalLightsShadowResolutionTier: 2
+  m_LightLayerMask: 1
+  m_RenderingLayers: 1
+  m_CustomShadowLayers: 0
+  m_ShadowLayerMask: 1
+  m_ShadowRenderingLayers: 1
+  m_LightCookieSize: {x: 1, y: 1}
+  m_LightCookieOffset: {x: 0, y: 0}
+  m_SoftShadowQuality: 0
 --- !u!1 &1568938494
 GameObject:
   m_ObjectHideFlags: 0