fr.jeanf.questsystem 0.0.1 → 0.0.2

package/Editor/InitializeQuestSystem.cs

@@ -0,0 +1,74 @@
+using System.IO;
+using jeanf.EventSystem;
+using UnityEditor;
+using UnityEngine;
+
+namespace jeanf.questsystem
+{
+    public class InitializeQuestSystem : MonoBehaviour
+    {
+        [MenuItem("GameObject/Initialize Quest System")]
+        private static void initializeQuestSystem()
+        {
+            var folder = "Quests";
+            var questFolderPath = $"Assets/Resources/{folder}";
+            
+            var channelFolder = "Channels";
+            var channelFolderPath = $"{questFolderPath}/{channelFolder}";
+            
+            // files needed
+            var questProgressChannel = $"QuestsProgressChannel.asset";
+            var startQuestEventChannel = $"StartQuestEventChannel.asset";
+
+            if (!AssetDatabase.IsValidFolder(questFolderPath))
+            {
+                AssetDatabase.CreateFolder("Assets/Resources", folder);
+            }
+            if (!AssetDatabase.IsValidFolder(channelFolderPath))
+            {
+                AssetDatabase.CreateFolder(questFolderPath, channelFolder);
+            }
+
+            CreateQuestStartEventChannelFile(channelFolderPath, startQuestEventChannel);
+            CreateQuestProgressChannelFile(channelFolderPath, questProgressChannel);
+        }
+        
+        public static void CreateQuestStartEventChannelFile(string path, string startEventChannel)
+        {
+            if (File.Exists($"{path}/{startEventChannel}"))
+            {
+                Debug.Log($"file: [{path}/{startEventChannel}] was found.");
+                return;
+            }
+
+            Debug.Log($"file: [{path}/{startEventChannel}] not found. Creating it for you.");
+            StringEventChannelSO asset = ScriptableObject.CreateInstance<StringEventChannelSO>();
+
+            AssetDatabase.CreateAsset(asset, $"{path}/{startEventChannel}");
+            AssetDatabase.SaveAssets();
+
+            EditorUtility.FocusProjectWindow();
+
+            Selection.activeObject = asset;
+        }
+
+        public static void CreateQuestProgressChannelFile(string path, string questProgressChannel)
+        {
+            if (File.Exists($"{path}/{questProgressChannel}"))
+            {
+                Debug.Log($"file: [{path}/{questProgressChannel}] was found.");
+                return;
+            }
+
+            Debug.Log($"file: [{path}/{questProgressChannel}] not found. Creating it for you.");
+            StringFloatEventChannelSO asset = ScriptableObject.CreateInstance<StringFloatEventChannelSO>();
+
+            AssetDatabase.CreateAsset(asset, $"{path}/{questProgressChannel}");
+            AssetDatabase.SaveAssets();
+
+            EditorUtility.FocusProjectWindow();
+
+            Selection.activeObject = asset;
+        }
+    }
+}

package/Editor/InitializeQuestSystem.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 3d2c56c7fb5108442a42778a7637bce6
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 097a66bf264d7704bbd95257cce71f41
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Quests/Quest_StethoscopeCheck.prefab

@@ -444,7 +444,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 6366255227919844238}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -459,7 +459,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 6366255227919844238}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}

package/Runtime/Quests/Quest_VisitAllPlaces.prefab

@@ -549,7 +549,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 740138255012303216}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -564,7 +564,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 740138255012303216}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}

package/Runtime/Quests/Quest_VisitPlaces.prefab

@@ -129,7 +129,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 1059188078616771896}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -144,7 +144,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 1059188078616771896}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}

package/Runtime/Scripts/Core/QuestItem.cs

@@ -1,115 +1,132 @@
-    using System;
-using System.Collections;
-using System.Collections.Generic;
 using jeanf.EventSystem;
 using UnityEngine;
+using UnityEngine.Serialization;
 
-public class QuestItem : MonoBehaviour, IDebugBehaviour
+namespace jeanf.questsystem
 {
-    public bool isDebug
-    { 
-        get => _isDebug;
-        set => _isDebug = value; 
-    }
-    [SerializeField] private bool _isDebug = false;
-    
-    [Tooltip("Visual feedback for the quest state")]
-    
-    
-    [Header("Quest")]
-    [SerializeField] private QuestInfoSO questInfoForPoint;
-    
-    [ReadOnly] [Range(0,1)] [SerializeField] private float progress = 0.0f;
-
-    [Header("Config")]
-    [SerializeField] private bool startPoint = true;
-    [SerializeField] private bool finishPoint = true;
-    
-    [SerializeField] [ReadOnly] private bool playerIsNear = false;
-    private string questId;
-    private QuestState currentQuestState;
-
-    // the event is Located in Assets/Resources/Quests/QuestsProgressChannel - it is searched for at Awake time.
-    private StringFloatEventChannelSO QuestProgress;
-
-    
-
-    private void Awake()
+    public class QuestItem : MonoBehaviour, IDebugBehaviour
     {
-        if (QuestProgress == null)
+        public bool isDebug
         {
-            if(isDebug) Debug.Log("attempting to find Quests/QuestsProgressChannel in the resources folder" ,this);
-            QuestProgress = Resources.Load<StringFloatEventChannelSO>("Quests/QuestsProgressChannel");
-            if(QuestProgress == null) Debug.LogError("Quests/QuestsProgressChannel is not in the resources folder",this);
+            get => _isDebug;
+            set => _isDebug = value;
         }
 
+        [SerializeField] private bool _isDebug = false;
 
-        var questIconPrefab = Instantiate(Resources.Load<GameObject>("Quests/QuestIcon"), this.transform);
-        
-        questId = questInfoForPoint.id;
-    }
+        [Tooltip("Visual feedback for the quest state")] [Header("Quest")] [SerializeField]
+        private QuestInfoSO questInfoForPoint;
 
-    private void OnEnable()
-    {
-        QuestProgress.OnEventRaised += UpdateProgress;
-        GameEventsManager.instance.questEvents.onQuestStateChange += QuestStateChange;
-        GameEventsManager.instance.inputEvents.onSubmitPressed += UpdateState;
-    }
+        [ReadOnly] [Range(0, 1)] [SerializeField]
+        private float progress = 0.0f;
 
-    private void OnDisable() => Unsubscribe();
-    private void OnDestroy() => Unsubscribe();
+        [FormerlySerializedAs("playerIsNear")] [SerializeField] [ReadOnly]
+        private bool clearToStart = false;
 
-    private void Unsubscribe()
-    {
-        QuestProgress.OnEventRaised -= UpdateProgress;
-        GameEventsManager.instance.questEvents.onQuestStateChange -= QuestStateChange;
-        GameEventsManager.instance.inputEvents.onSubmitPressed -= UpdateState;
-    }
+        private string questId;
+        private QuestState currentQuestState;
 
-    public void UpdateState()
-    {
-        if (isDebug) Debug.Log($"Updating State...");
-        if (!playerIsNear)
+        // 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;
+
+        public void OnValidate()
         {
-            return;
+            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";
+
+            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);
+            }
+
+            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);
+            }
+
+            questId = questInfoForPoint.id;
         }
-        if (isDebug) Debug.Log($"Player is near, continuing ...");
 
-        // start or finish a quest
-        if (currentQuestState.Equals(QuestState.CAN_START) && startPoint)
+        private void OnEnable()
         {
-            if(isDebug) Debug.Log($"Starting quest: {questId}");
-            GameEventsManager.instance.questEvents.StartQuest(questId);
+            StartQuestEventChannel.OnEventRaised += RequestQuestStart;
+            QuestProgress.OnEventRaised += UpdateProgress;
+            GameEventsManager.instance.questEvents.onQuestStateChange += QuestStateChange;
+            GameEventsManager.instance.inputEvents.onSubmitPressed += UpdateState;
         }
-        else if (currentQuestState.Equals(QuestState.CAN_FINISH) && finishPoint)
+
+        private void OnDisable() => Unsubscribe();
+        private void OnDestroy() => Unsubscribe();
+
+        private void Unsubscribe()
         {
-            if(isDebug) Debug.Log($"Finishing quest: {questId}");
-            GameEventsManager.instance.questEvents.FinishQuest(questId);
+            StartQuestEventChannel.OnEventRaised -= RequestQuestStart;
+            QuestProgress.OnEventRaised -= UpdateProgress;
+            GameEventsManager.instance.questEvents.onQuestStateChange -= QuestStateChange;
+            GameEventsManager.instance.inputEvents.onSubmitPressed -= UpdateState;
         }
-    }
 
-    private void UpdateProgress(string id, float progress)
-    {
-        if (id == questId)
+        public void UpdateState()
         {
-            this.progress = progress;
-            if(isDebug) Debug.Log($"questid [{id}] progress = {progress*100}%");
+            if (isDebug) Debug.Log($"Updating State...");
+            if (!clearToStart)
+            {
+                return;
+            }
+
+            if (isDebug) Debug.Log($"All is clear, continuing ...");
+
+            // start or finish a quest
+            if (currentQuestState.Equals(QuestState.CAN_START))
+            {
+                if (isDebug) Debug.Log($"Starting quest: {questId}");
+                GameEventsManager.instance.questEvents.StartQuest(questId);
+            }
+            else if (currentQuestState.Equals(QuestState.CAN_FINISH))
+            {
+                if (isDebug) Debug.Log($"Finishing quest: {questId}");
+                GameEventsManager.instance.questEvents.FinishQuest(questId);
+            }
         }
 
-    }
+        private void UpdateProgress(string id, float progress)
+        {
+            if (id == questId)
+            {
+                this.progress = progress;
+                if (isDebug) Debug.Log($"questid [{id}] progress = {progress * 100}%");
+            }
+        }
 
-    private void QuestStateChange(Quest quest)
-    {
-        // only update the quest state if this point has the corresponding quest
-        if (quest.info.id.Equals(questId))
+        private void QuestStateChange(Quest quest)
         {
-            currentQuestState = quest.state;
+            // only update the quest state if this point has the corresponding quest
+            if (quest.info.id.Equals(questId))
+            {
+                currentQuestState = quest.state;
+            }
         }
-    }
 
-    public void PlayerIsNear(bool value)
-    {
-        playerIsNear = value;
-        UpdateState();
+        public void AllClear(bool value)
+        {
+            clearToStart = value;
+            UpdateState();
+        }
+
+        public void RequestQuestStart(string id)
+        {
+            if(id!= questId) return;
+            AllClear(true);
+        }
     }
-}
+}

package/Runtime/Scripts/quests/Quest_StethoscopeCheck.prefab

@@ -444,7 +444,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 6366255227919844238}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -459,7 +459,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 6366255227919844238}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}

package/Runtime/Scripts/quests/Quest_VisitAllPlaces.prefab

@@ -549,7 +549,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 740138255012303216}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -564,7 +564,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 740138255012303216}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}

package/Runtime/Scripts/quests/Quest_VisitPlaces.prefab

@@ -129,7 +129,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 1059188078616771896}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}
@@ -144,7 +144,7 @@ MonoBehaviour:
       m_Calls:
       - m_Target: {fileID: 1059188078616771896}
         m_TargetAssemblyTypeName: QuestPoint, Assembly-CSharp
-        m_MethodName: PlayerIsNear
+        m_MethodName: AllClear
         m_Mode: 6
         m_Arguments:
           m_ObjectArgument: {fileID: 0}

package/package.json

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