FEAT: add day night cycle in sleep decision (#49)

Author: ArthurTakase

Assets/Prefabs/Animals/Animal_Deer.prefab

@@ -487,6 +487,10 @@ PrefabInstance:
       propertyPath: moveSpeed
       value: 0.5
       objectReference: {fileID: 0}
+    - target: {fileID: -8264934038213892515, guid: 220ad0de1e362494dbef72b2bbadedd8, type: 3}
+      propertyPath: sleepType
+      value: 1
+      objectReference: {fileID: 0}
     - target: {fileID: -8264934038213892515, guid: 220ad0de1e362494dbef72b2bbadedd8, type: 3}
       propertyPath: maxMoveTime
       value: 10

Assets/Prefabs/Animals/Animal_Tiger.prefab

@@ -20,6 +20,10 @@ PrefabInstance:
       propertyPath: moveSpeed
       value: 1.2
       objectReference: {fileID: 0}
+    - target: {fileID: -8264934038213892515, guid: 220ad0de1e362494dbef72b2bbadedd8, type: 3}
+      propertyPath: sleepType
+      value: 1
+      objectReference: {fileID: 0}
     - target: {fileID: -8264934038213892515, guid: 220ad0de1e362494dbef72b2bbadedd8, type: 3}
       propertyPath: maxMoveTime
       value: 60

Assets/Scripts/Animal/Animal.cs

@@ -39,6 +39,13 @@ public enum FoodType
     Carnivore
 }
 
+public enum SleepType
+{
+    Day,
+    Night,
+    None
+}
+
 public class Animal : MonoBehaviour
 {
     [HideInInspector] public NavMeshAgent navAgent;
@@ -92,6 +99,7 @@ public class Animal : MonoBehaviour
     public bool NeedToSleep => sleepValue <= 1;
     [HideInInspector] public bool isSleeping = false;
     public float sleepSpeed = 10f;
+    public SleepType sleepType;
 
     [HideInInspector] public bool isDead = false;
     [HideInInspector] public readonly List<GameObject> notReachableElements = new();

Assets/Scripts/Animal/DecisionTree.cs

@@ -122,7 +122,9 @@ public void Start()
 
         Node NeedToSleep = new(animal =>
             {
-                return animal.NeedToSleep || animal.isSleeping;
+                bool isInSleepTime = (animal.sleepType == SleepType.Day && DayNightCycle.Instance.currentTimeOfDay == TimeOfDay.Day) ||
+                                    (animal.sleepType == SleepType.Night && DayNightCycle.Instance.currentTimeOfDay == TimeOfDay.Night);
+                return (isInSleepTime && animal.sleepValue < 50) || animal.NeedToSleep || animal.isSleeping;
             },
             OnSleepLocation,
             NeedToEat);

Assets/TestsPlayMode/Decision.cs

@@ -45,6 +45,8 @@ public IEnumerator Setup()
         ARtoVR.Instance.ToggleMode();
         yield return new WaitForSeconds(ARtoVR.Instance.transitionDuration + 3);
 
+        DayNightCycle.Instance.currentTimeOfDay = TimeOfDay.Day;
+
         // ----- DecisionTree -----
         Assert.AreEqual(deer.eventType, EventType.Random);
         tree.Callback(deer);
@@ -188,5 +190,29 @@ public IEnumerator SleepBehaviour()
         tree.Callback(deer);
         Assert.AreEqual(deer.eventType, EventType.Sleep);
         yield return null;
+
+        DayNightCycle.Instance.currentTimeOfDay = TimeOfDay.Night;
+        tree.Callback(deer);
+        Assert.AreEqual(deer.eventType, EventType.Sleep);
+        yield return null;
+
+        DayNightCycle.Instance.currentTimeOfDay = TimeOfDay.Day;
+        tree.Callback(deer);
+        Assert.AreEqual(deer.eventType, EventType.Sleep);
+        yield return null;
+
+        DayNightCycle.Instance.currentTimeOfDay = TimeOfDay.Day;
+        deer.sleepValue = 40f;
+        deer.isSleeping = false;
+        tree.Callback(deer);
+        Assert.AreEqual(deer.eventType, EventType.Random);
+        yield return null;
+
+        DayNightCycle.Instance.currentTimeOfDay = TimeOfDay.Day;
+        deer.sleepValue = 100f;
+        deer.isSleeping = false;
+        tree.Callback(deer);
+        Assert.AreEqual(deer.eventType, EventType.Random);
+        yield return null;
     }
 }