fr.jeanf.questsystem 0.0.8 → 0.0.10

package/Editor/InitializeQuestSystem.cs

@@ -18,6 +18,8 @@ namespace jeanf.questsystem
             var channelFolderPath = $"{questFolderPath}/{channelFolder}";
             
             // files needed
+            var questStatusUpdate = "QuestStatusUpdate.asset";
+            var questRequirementCheck = "QuestRequirementCheck.asset";
             var questProgressChannel = $"QuestsProgressChannel.asset";
             var startQuestEventChannel = $"StartQuestEventChannel.asset";
 
@@ -30,22 +32,24 @@ namespace jeanf.questsystem
                 AssetDatabase.CreateFolder(questFolderPath, channelFolder);
             }
 
-            CreateQuestStartEventChannelFile(channelFolderPath, startQuestEventChannel);
-            CreateQuestProgressChannelFile(channelFolderPath, questProgressChannel);
+            CreateStringEventFile(channelFolderPath, questStatusUpdate);
+            CreateStringEventFile(channelFolderPath, questRequirementCheck);
+            CreateStringEventFile(channelFolderPath, startQuestEventChannel);
+            CreateStringFloatEventFile(channelFolderPath, questProgressChannel);
         }
         
-        public static void CreateQuestStartEventChannelFile(string path, string startEventChannel)
+        public static void CreateStringEventFile(string path, string fileName)
         {
-            if (File.Exists($"{path}/{startEventChannel}"))
+            if (File.Exists($"{path}/{fileName}"))
             {
-                Debug.Log($"file: [{path}/{startEventChannel}] was found.");
+                Debug.Log($"file: [{path}/{fileName}] was found.");
                 return;
             }
 
-            Debug.Log($"file: [{path}/{startEventChannel}] not found. Creating it for you.");
+            Debug.Log($"file: [{path}/{fileName}] not found. Creating it for you.");
             StringEventChannelSO asset = ScriptableObject.CreateInstance<StringEventChannelSO>();
 
-            AssetDatabase.CreateAsset(asset, $"{path}/{startEventChannel}");
+            AssetDatabase.CreateAsset(asset, $"{path}/{fileName}");
             AssetDatabase.SaveAssets();
 
             EditorUtility.FocusProjectWindow();
@@ -53,24 +57,25 @@ namespace jeanf.questsystem
             Selection.activeObject = asset;
         }
 
-        public static void CreateQuestProgressChannelFile(string path, string questProgressChannel)
+        public static void CreateStringFloatEventFile(string path, string fileName)
         {
-            if (File.Exists($"{path}/{questProgressChannel}"))
+            if (File.Exists($"{path}/{fileName}"))
             {
-                Debug.Log($"file: [{path}/{questProgressChannel}] was found.");
+                Debug.Log($"file: [{path}/{fileName}] was found.");
                 return;
             }
 
-            Debug.Log($"file: [{path}/{questProgressChannel}] not found. Creating it for you.");
+            Debug.Log($"file: [{path}/{fileName}] not found. Creating it for you.");
             StringFloatEventChannelSO asset = ScriptableObject.CreateInstance<StringFloatEventChannelSO>();
 
-            AssetDatabase.CreateAsset(asset, $"{path}/{questProgressChannel}");
+            AssetDatabase.CreateAsset(asset, $"{path}/{fileName}");
             AssetDatabase.SaveAssets();
 
             EditorUtility.FocusProjectWindow();
 
             Selection.activeObject = asset;
         }
+        
     }
     #endif
 }

package/Runtime/Quests/Quest_StethoscopeCheck.prefab

@@ -166,6 +166,8 @@ MonoBehaviour:
   m_Name: 
   m_EditorClassIdentifier: 
   _isDebug: 1
+  _startQuestOnEnable: 0
   questInfoForPoint: {fileID: 11400000, guid: b7b6381ae7b9c2244862b31a1ce5b2f5, type: 2}
   progress: 0
   clearToStart: 0
+  requirementCheck: {fileID: 0}

package/Runtime/Scripts/Core/QuestItem.cs

@@ -1,18 +1,21 @@
 using System;
+using System.Collections.Generic;
 using jeanf.EventSystem;
 using UnityEngine;
 using UnityEngine.Serialization;
 using jeanf.propertyDrawer;
+using jeanf.validationTools;
 
 namespace jeanf.questsystem
 {
-    public class QuestItem : MonoBehaviour, IDebugBehaviour
+    public class QuestItem : MonoBehaviour, IDebugBehaviour, IValidatable
     {
         public bool isDebug
         {
             get => _isDebug;
             set => _isDebug = value;
         }
+        public bool IsValid { get; private set; }
 
         [SerializeField] private bool _isDebug = false;
         [SerializeField] private bool _startQuestOnEnable = false;
@@ -31,36 +34,91 @@ namespace jeanf.questsystem
 
         // these events are Located in Assets/Resources/Quests/Channels - it is searched for at Awake time.
         // if they do not exist simply right click in the hierarchy and find >InitializeQuestSystem<
-        private StringFloatEventChannelSO QuestProgress;
-        private StringEventChannelSO StartQuestEventChannel;
+        [Header("Listening on:")] 
+        [SerializeField] [Validation("A reference to the QuestProgress SO is required")] private StringFloatEventChannelSO QuestProgress;
+        [SerializeField] [Validation("A reference to the StartQuestEventChannel SO is required")] private StringEventChannelSO StartQuestEventChannel;
+
+        [Header("Broadcasting on:")] [SerializeField] [Validation("A reference to the QuestRequirementCheck SO is required")]
+        private StringEventChannelSO requirementCheck;
 
         public void OnValidate()
+        {
+            #if UNITY_EDITOR
+            ValididtyCheck();
+            #endif
+            
+            questId = questInfoForPoint.id;
+        }
+
+        private void ValididtyCheck()
         {
             const string searching = "attempting to find";
             const string _ = "Quests/Channels"; // search target
             const string searchLocation = "the resources folder";
             const string readInstructions = "please read the package instruction for further help";
-
+            
+            
+            var validityCheck = true;
+            var invalidObjects = new List<object>();
+            var errorMessages = new List<string>();
+            
             if (QuestProgress == null)
             {
                 if (isDebug) Debug.Log($"{searching} {_}/QuestsProgressChannel in {searchLocation} ", this);
                 QuestProgress = Resources.Load<StringFloatEventChannelSO>($"{_}/QuestsProgressChannel");
                 if (QuestProgress == null)
-                    Debug.LogError($"{_}/QuestsProgressChannel is not in {searchLocation} {readInstructions}", this);
+                {
+                    errorMessages.Add($"{_}/QuestsProgressChannel is not in {searchLocation} {readInstructions}");
+                    validityCheck = false;
+                    invalidObjects.Add(QuestProgress);
+                }
+
             }
 
             if (StartQuestEventChannel == null)
             {
                 if (isDebug) Debug.Log($"{searching} {_}/StartQuestEventChannel in {searchLocation}", this);
                 StartQuestEventChannel = Resources.Load<StringEventChannelSO>($"{_}/StartQuestEventChannel");
-                if (QuestProgress == null)
-                    Debug.LogError($"{_}/StartQuestEventChannel is not {searchLocation} {readInstructions}", this);
+                if (StartQuestEventChannel == null)
+                {
+                    errorMessages.Add($"{_}/StartQuestEventChannel is not {searchLocation} {readInstructions}");
+                    validityCheck = false;
+                    invalidObjects.Add(StartQuestEventChannel);
+                }
             }
 
-            questId = questInfoForPoint.id;
+
+            if (requirementCheck == null)
+            {
+                if (isDebug) Debug.Log($"{searching} {_}/QuestRequirementCheck in {searchLocation}", this);
+                requirementCheck = Resources.Load<StringEventChannelSO>($"{_}/QuestRequirementCheck");
+                if (requirementCheck == null)
+                {
+                    errorMessages.Add($"{_}/QuestRequirementCheck is not {searchLocation} {readInstructions}");
+                    validityCheck = false;
+                    invalidObjects.Add(requirementCheck);
+                }
+            }
+            
+            IsValid = validityCheck;
+            if(!IsValid) return;
+
+            if (IsValid && !Application.isPlaying) return;
+            for(var i = 0 ; i < invalidObjects.Count ; i++)
+            {
+                Debug.LogError($"Error: {errorMessages[i]} " , this.gameObject);
+            }
+        }
+
+        private void OnEnable()
+        {
+            Subscribe();
+
+            requirementCheck.RaiseEvent(questId);
+            if (!_startQuestOnEnable) return;
+            RequestQuestStart(questId);
         }
 
-        private void OnEnable() => Subscribe();
         private void OnDisable() => Unsubscribe();
         private void OnDestroy() => Unsubscribe();
 
@@ -90,6 +148,12 @@ namespace jeanf.questsystem
 
             if (isDebug) Debug.Log($"All is clear, continuing ...");
 
+            if (currentQuestState.Equals(QuestState.REQUIREMENTS_NOT_MET) && _startQuestOnEnable)
+            {
+                if(isDebug) Debug.Log($"forcing start of quest: {questId}");
+                GameEventsManager.instance.questEvents.StartQuest(questId);
+            }
+
             // start or finish a quest
             if (currentQuestState.Equals(QuestState.CAN_START))
             {
@@ -118,15 +182,14 @@ namespace jeanf.questsystem
             if (quest.info.id.Equals(questId))
             {
                 currentQuestState = quest.state;
-                
-                // start on enable option
-                if (_startQuestOnEnable && quest.state == QuestState.CAN_START) RequestQuestStart(quest.info.id);
             }
         }
 
         public void AllClear(bool value)
         {
             clearToStart = value;
+            currentQuestState = QuestState.CAN_START;
+            requirementCheck.RaiseEvent(questId);
             UpdateState();
         }
 
@@ -136,5 +199,6 @@ namespace jeanf.questsystem
             AllClear(true);
             if(isDebug) Debug.Log($"Quest start was requested for quest {id}.", this);
         }
+
     }
 }

package/Runtime/Scripts/Core/QuestManager.cs

@@ -2,27 +2,31 @@ using System;
 using System.Collections;
 using System.Collections.Generic;
 using jeanf.EventSystem;
+using jeanf.validationTools;
 using UnityEngine;
 using UnityEngine.Serialization;
 
 namespace jeanf.questsystem
 {
-    public class QuestManager : MonoBehaviour, IDebugBehaviour
+    public class QuestManager : MonoBehaviour, IDebugBehaviour, IValidatable
     {
         public bool isDebug
         {
             get => _isDebug;
             set => _isDebug = value;
         }
+        public bool IsValid { get; private set; }
 
         [SerializeField] private bool _isDebug = false;
 
         [FormerlySerializedAs("loadQuestState")] [Header("Config")] [SerializeField]
         private bool loadSavedQuestState = true;
 
-        [Header("Broadcasting on:")] [SerializeField]
-        private StringEventChannelSO questStatusUpdateChannel;
-        private StringFloatEventChannelSO questProgress;
+        [Header("Broadcasting on:")]
+        [SerializeField] [Validation("A reference to the questStatusUpdateChannel is required.")] private StringEventChannelSO questStatusUpdateChannel;
+        [SerializeField] [Validation("A reference to the questProgress is required.")] private StringFloatEventChannelSO questProgress;
+
+        [Header("Listening on:")] [SerializeField] [Validation("A reference to the questStatusUpdateRequested is required.")] private StringEventChannelSO questStatusUpdateRequested;
 
         private Dictionary<string, Quest> questMap;
 
@@ -43,6 +47,8 @@ namespace jeanf.questsystem
             GameEventsManager.instance.questEvents.onQuestStepStateChange += QuestStepStateChange;
 
             GameEventsManager.instance.playerEvents.onPlayerLevelChange += PlayerLevelChange;
+
+            questStatusUpdateRequested.OnEventRaised += ctx => CheckRequirementsMet(questMap[ctx]);
         }
 
         private void OnDisable()
@@ -97,6 +103,8 @@ namespace jeanf.questsystem
                     meetsRequirements = false;
                 }
             }
+            
+            if(isDebug) Debug.Log($"checking requirements for quest: {quest.info.name}, [{quest.info.id}], meetsRequirements: {meetsRequirements}");
 
             return meetsRequirements;
         }
@@ -269,5 +277,68 @@ namespace jeanf.questsystem
 
             return quest;
         }
+        private void ValididtyCheck()
+        {
+            const string searching = "attempting to find";
+            const string _ = "Quests/Channels"; // search target
+            const string searchLocation = "the resources folder";
+            const string readInstructions = "please read the package instruction for further help";
+            
+            
+            var validityCheck = true;
+            var invalidObjects = new List<object>();
+            var errorMessages = new List<string>();
+            
+            if (questStatusUpdateChannel == null)
+            {
+                if (isDebug) Debug.Log($"{searching} {_}/QuestStatusUpdate in {searchLocation}", this);
+                questStatusUpdateChannel = Resources.Load<StringEventChannelSO>($"{_}/QuestStatusUpdate");
+                if (questStatusUpdateChannel == null)
+                {
+                    errorMessages.Add($"{_}/QuestStatusUpdate is not {searchLocation} {readInstructions}");
+                    validityCheck = false;
+                    invalidObjects.Add(questStatusUpdateChannel);
+                }
+            }
+            
+            if (questProgress == null)
+            {
+                if (isDebug) Debug.Log($"{searching} {_}/QuestsProgressChannel in {searchLocation}", this);
+                questProgress = Resources.Load<StringFloatEventChannelSO>($"{_}/QuestsProgressChannel");
+                if (questProgress == null)
+                {
+                    errorMessages.Add($"{_}/QuestsProgressChannel is not {searchLocation} {readInstructions}");
+                    validityCheck = false;
+                    invalidObjects.Add(questProgress);
+                }
+            }
+            
+            if (questStatusUpdateRequested == null)
+            {
+                if (isDebug) Debug.Log($"{searching} {_}/QuestRequirementCheck in {searchLocation}", this);
+                questStatusUpdateRequested = Resources.Load<StringEventChannelSO>($"{_}/QuestRequirementCheck");
+                if (questStatusUpdateRequested == null)
+                {
+                    errorMessages.Add($"{_}/QuestRequirementCheck is not {searchLocation} {readInstructions}");
+                    validityCheck = false;
+                    invalidObjects.Add(questStatusUpdateRequested);
+                }
+            }
+            
+            IsValid = validityCheck;
+            if(!IsValid) return;
+
+            if (IsValid && !Application.isPlaying) return;
+            for(var i = 0 ; i < invalidObjects.Count ; i++)
+            {
+                Debug.LogError($"Error: {errorMessages[i]} " , this.gameObject);
+            }
+        }
+        public void OnValidate()
+        {
+            #if UNITY_EDITOR
+            ValididtyCheck();
+            #endif
+        }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name":"fr.jeanf.questsystem",
-  "version":"0.0.8",
+  "version":"0.0.10",
   "displayName":"Quest system",
   "description":"This package uses Scriptable Objects to define quests.",
   "unity": "2021.3",