fr.jeanf.questsystem 0.0.2 → 0.0.4

package/Runtime/Scripts/Core/QuestManager.cs

@@ -4,240 +4,258 @@ using jeanf.EventSystem;
 using UnityEngine;
 using UnityEngine.Serialization;
 
-public class QuestManager : MonoBehaviour, IDebugBehaviour
+namespace jeanf.questsystem
 {
-    public bool isDebug
-    { 
-        get => _isDebug;
-        set => _isDebug = value; 
-    }
-    [SerializeField] private bool _isDebug = false;
-    [FormerlySerializedAs("loadQuestState")]
-    [Header("Config")]
-    [SerializeField] private bool loadSavedQuestState = true;
-    [Header("Broadcasting on:")] [SerializeField] private StringEventChannelSO questStatusUpdateChannel;
-    [Header("Broadcasting on:")] [SerializeField] private StringFloatEventChannelSO questProgress;
+    public class QuestManager : MonoBehaviour, IDebugBehaviour
+    {
+        public bool isDebug
+        {
+            get => _isDebug;
+            set => _isDebug = value;
+        }
 
-    private Dictionary<string, Quest> questMap;
+        [SerializeField] private bool _isDebug = false;
 
-    // quest start requirements
-    private int currentPlayerLevel;
+        [FormerlySerializedAs("loadQuestState")] [Header("Config")] [SerializeField]
+        private bool loadSavedQuestState = true;
 
-    private void Awake()
-    {
-        questMap = CreateQuestMap();
-    }
+        [Header("Broadcasting on:")] [SerializeField]
+        private StringEventChannelSO questStatusUpdateChannel;
 
-    private void OnEnable()
-    {
-        GameEventsManager.instance.questEvents.onStartQuest += StartQuest;
-        GameEventsManager.instance.questEvents.onAdvanceQuest += AdvanceQuest;
-        GameEventsManager.instance.questEvents.onFinishQuest += FinishQuest;
+        [Header("Broadcasting on:")] [SerializeField]
+        private StringFloatEventChannelSO questProgress;
 
-        GameEventsManager.instance.questEvents.onQuestStepStateChange += QuestStepStateChange;
+        private Dictionary<string, Quest> questMap;
 
-        GameEventsManager.instance.playerEvents.onPlayerLevelChange += PlayerLevelChange;
-    }
+        // quest start requirements
+        private int currentPlayerLevel;
 
-    private void OnDisable()
-    {
-        GameEventsManager.instance.questEvents.onStartQuest -= StartQuest;
-        GameEventsManager.instance.questEvents.onAdvanceQuest -= AdvanceQuest;
-        GameEventsManager.instance.questEvents.onFinishQuest -= FinishQuest;
+        private void Awake()
+        {
+            questMap = CreateQuestMap();
+        }
 
-        GameEventsManager.instance.questEvents.onQuestStepStateChange -= QuestStepStateChange;
+        private void OnEnable()
+        {
+            GameEventsManager.instance.questEvents.onStartQuest += StartQuest;
+            GameEventsManager.instance.questEvents.onAdvanceQuest += AdvanceQuest;
+            GameEventsManager.instance.questEvents.onFinishQuest += FinishQuest;
 
-        GameEventsManager.instance.playerEvents.onPlayerLevelChange -= PlayerLevelChange;
-    }
+            GameEventsManager.instance.questEvents.onQuestStepStateChange += QuestStepStateChange;
 
-    private void Start()
-    {
-        
-        foreach (Quest quest in questMap.Values)
-        {
-            // initialize any loaded quest steps
-            if (quest.state == QuestState.IN_PROGRESS)
-            {
-                quest.InstantiateCurrentQuestStep(this.transform);
-            }
-            // broadcast the initial state of all quests on startup
-            GameEventsManager.instance.questEvents.QuestStateChange(quest);
+            GameEventsManager.instance.playerEvents.onPlayerLevelChange += PlayerLevelChange;
         }
-    }
 
-    private void ChangeQuestState(string id, QuestState state)
-    {
-        Quest quest = GetQuestById(id);
-        quest.state = state;
-        GameEventsManager.instance.questEvents.QuestStateChange(quest);
-    }
+        private void OnDisable()
+        {
+            GameEventsManager.instance.questEvents.onStartQuest -= StartQuest;
+            GameEventsManager.instance.questEvents.onAdvanceQuest -= AdvanceQuest;
+            GameEventsManager.instance.questEvents.onFinishQuest -= FinishQuest;
 
-    private void PlayerLevelChange(int level)
-    {
-        currentPlayerLevel = level;
-    }
+            GameEventsManager.instance.questEvents.onQuestStepStateChange -= QuestStepStateChange;
 
-    private bool CheckRequirementsMet(Quest quest)
-    {
-        // check player level requirements
-        var meetsRequirements = !(currentPlayerLevel < quest.info.levelRequirement);
+            GameEventsManager.instance.playerEvents.onPlayerLevelChange -= PlayerLevelChange;
+        }
 
-        // check quest prerequisites for completion
-        foreach (QuestInfoSO prerequisiteQuestInfo in quest.info.questPrerequisites)
+        private void Start()
         {
-            if (GetQuestById(prerequisiteQuestInfo.id).state != QuestState.FINISHED)
+
+            foreach (Quest quest in questMap.Values)
             {
-                meetsRequirements = false;
+                // initialize any loaded quest steps
+                if (quest.state == QuestState.IN_PROGRESS)
+                {
+                    quest.InstantiateCurrentQuestStep(this.transform);
+                }
+
+                // broadcast the initial state of all quests on startup
+                GameEventsManager.instance.questEvents.QuestStateChange(quest);
             }
         }
 
-        return meetsRequirements;
-    }
+        private void ChangeQuestState(string id, QuestState state)
+        {
+            Quest quest = GetQuestById(id);
+            quest.state = state;
+            GameEventsManager.instance.questEvents.QuestStateChange(quest);
+        }
 
-    private void Update()
-    {
-        // loop through ALL quests
-        foreach (Quest quest in questMap.Values)
+        private void PlayerLevelChange(int level)
         {
-            // if we're now meeting the requirements, switch over to the CAN_START state
-            if (quest.state == QuestState.REQUIREMENTS_NOT_MET && CheckRequirementsMet(quest))
-            {
-                ChangeQuestState(quest.info.id, QuestState.CAN_START);
-            }
+            currentPlayerLevel = level;
         }
-    }
 
-    private void StartQuest(string id) 
-    {
-        Quest quest = GetQuestById(id);
-        quest.InstantiateCurrentQuestStep(this.transform);
-        ChangeQuestState(quest.info.id, QuestState.IN_PROGRESS);
-        SaveQuest(quest);
-    }
+        private bool CheckRequirementsMet(Quest quest)
+        {
+            // check player level requirements
+            var meetsRequirements = !(currentPlayerLevel < quest.info.levelRequirement);
 
-    private void AdvanceQuest(string id)
-    {
-        Quest quest = GetQuestById(id);
+            // check quest prerequisites for completion
+            foreach (QuestInfoSO prerequisiteQuestInfo in quest.info.questPrerequisites)
+            {
+                if (GetQuestById(prerequisiteQuestInfo.id).state != QuestState.FINISHED)
+                {
+                    meetsRequirements = false;
+                }
+            }
 
-        // move on to the next step
-        quest.MoveToNextStep();
-        if(isDebug) Debug.Log($"[{quest.info.id}]quest state: {quest.state} - {quest.currentStep} over {quest.info.questStepPrefabs.Length} steps done", this);
-        questStatusUpdateChannel.RaiseEvent($"[{quest.info.id}]quest state: {quest.state} - {quest.currentStep} over {quest.info.questStepPrefabs.Length} steps done");
-        var progress = (float) quest.currentStep / quest.info.questStepPrefabs.Length;
-        if(isDebug) Debug.Log($"[{quest.info.id}] progress: {progress*100}%", this);
-        questProgress.RaiseEvent(quest.info.id, progress);
+            return meetsRequirements;
+        }
 
-        // if there are more steps, instantiate the next one
-        if (quest.CurrentStepExists())
+        private void Update()
         {
-            quest.InstantiateCurrentQuestStep(this.transform);
+            // loop through ALL quests
+            foreach (Quest quest in questMap.Values)
+            {
+                // if we're now meeting the requirements, switch over to the CAN_START state
+                if (quest.state == QuestState.REQUIREMENTS_NOT_MET && CheckRequirementsMet(quest))
+                {
+                    ChangeQuestState(quest.info.id, QuestState.CAN_START);
+                }
+            }
         }
-        // if there are no more steps, then we've finished all of them for this quest
-        else
+
+        private void StartQuest(string id)
         {
-            ChangeQuestState(quest.info.id, QuestState.CAN_FINISH);
+            Quest quest = GetQuestById(id);
+            quest.InstantiateCurrentQuestStep(this.transform);
+            ChangeQuestState(quest.info.id, QuestState.IN_PROGRESS);
+            SaveQuest(quest);
         }
-        SaveQuest(quest);
-    }
 
-    private void FinishQuest(string id)
-    {
-        Quest quest = GetQuestById(id);
-        ClaimRewards(quest);
-        ChangeQuestState(quest.info.id, QuestState.FINISHED);
-        questStatusUpdateChannel.RaiseEvent($"[{quest.info.id}] quest is finished.");
-        questProgress.RaiseEvent(quest.info.id,1);
-        SaveQuest(quest);
-    }
-
-    private void ClaimRewards(Quest quest)
-    {
-        GameEventsManager.instance.scenarioEvents.ScenarioUnlocked(quest.info.unlockedScenario);
-    }
+        private void AdvanceQuest(string id)
+        {
+            Quest quest = GetQuestById(id);
 
-    private void QuestStepStateChange(string id, int stepIndex, QuestStepState questStepState)
-    {
-        Quest quest = GetQuestById(id);
-        quest.StoreQuestStepState(questStepState, stepIndex);
-        ChangeQuestState(id, quest.state);
-    }
+            // move on to the next step
+            quest.MoveToNextStep();
+            if (isDebug)
+                Debug.Log(
+                    $"[{quest.info.id}]quest state: {quest.state} - {quest.currentStep} over {quest.info.questStepPrefabs.Length} steps done",
+                    this);
+            questStatusUpdateChannel.RaiseEvent(
+                $"[{quest.info.id}]quest state: {quest.state} - {quest.currentStep} over {quest.info.questStepPrefabs.Length} steps done");
+            var progress = (float)quest.currentStep / quest.info.questStepPrefabs.Length;
+            if (isDebug) Debug.Log($"[{quest.info.id}] progress: {progress * 100}%", this);
+            questProgress.RaiseEvent(quest.info.id, progress);
 
-    private Dictionary<string, Quest> CreateQuestMap()
-    {
-        // loads all QuestInfoSO Scriptable Objects under the Assets/Resources/Quests folder
-        QuestInfoSO[] allQuests = Resources.LoadAll<QuestInfoSO>("Quests");
-        // Create the quest map
-        Dictionary<string, Quest> idToQuestMap = new Dictionary<string, Quest>();
-        foreach (QuestInfoSO questInfo in allQuests)
-        {
-            if (idToQuestMap.ContainsKey(questInfo.id))
+            // if there are more steps, instantiate the next one
+            if (quest.CurrentStepExists())
             {
-                Debug.LogWarning("Duplicate ID found when creating quest map: " + questInfo.id);
+                quest.InstantiateCurrentQuestStep(this.transform);
             }
-            idToQuestMap.Add(questInfo.id, LoadQuest(questInfo));
+            // if there are no more steps, then we've finished all of them for this quest
+            else
+            {
+                ChangeQuestState(quest.info.id, QuestState.CAN_FINISH);
+            }
+
+            SaveQuest(quest);
         }
-        return idToQuestMap;
-    }
 
-    private Quest GetQuestById(string id)
-    {
-        Quest quest = questMap[id];
-        if (quest == null)
+        private void FinishQuest(string id)
         {
-            Debug.LogError("ID not found in the Quest Map: " + id);
+            Quest quest = GetQuestById(id);
+            ClaimRewards(quest);
+            ChangeQuestState(quest.info.id, QuestState.FINISHED);
+            questStatusUpdateChannel.RaiseEvent($"[{quest.info.id}] quest is finished.");
+            questProgress.RaiseEvent(quest.info.id, 1);
+            SaveQuest(quest);
         }
-        return quest;
-    }
 
-    private void OnApplicationQuit()
-    {
-        foreach (Quest quest in questMap.Values)
+        private void ClaimRewards(Quest quest)
         {
-            SaveQuest(quest);
+            GameEventsManager.instance.scenarioEvents.ScenarioUnlocked(quest.info.unlockedScenario);
         }
-    }
 
-    private void SaveQuest(Quest quest)
-    {
-        try 
+        private void QuestStepStateChange(string id, int stepIndex, QuestStepState questStepState)
         {
-            QuestData questData = quest.GetQuestData();
-            // serialize using JsonUtility, but use whatever you want here (like JSON.NET)
-            string serializedData = JsonUtility.ToJson(questData);
-            Debug.Log($"saved data {serializedData}");
-            // saving to PlayerPrefs is just a quick example for this tutorial video,
-            // you probably don't want to save this info there long-term.
-            // instead, use an actual Save & Load system and write to a file, the cloud, etc..
-            PlayerPrefs.SetString(quest.info.id, serializedData);
+            Quest quest = GetQuestById(id);
+            quest.StoreQuestStepState(questStepState, stepIndex);
+            ChangeQuestState(id, quest.state);
         }
-        catch (System.Exception e)
+
+        private Dictionary<string, Quest> CreateQuestMap()
         {
-            Debug.LogError("Failed to save quest with id " + quest.info.id + ": " + e);
+            // loads all QuestInfoSO Scriptable Objects under the Assets/Resources/Quests folder
+            QuestInfoSO[] allQuests = Resources.LoadAll<QuestInfoSO>("Quests");
+            // Create the quest map
+            Dictionary<string, Quest> idToQuestMap = new Dictionary<string, Quest>();
+            foreach (QuestInfoSO questInfo in allQuests)
+            {
+                if (idToQuestMap.ContainsKey(questInfo.id))
+                {
+                    Debug.LogWarning("Duplicate ID found when creating quest map: " + questInfo.id);
+                }
+
+                idToQuestMap.Add(questInfo.id, LoadQuest(questInfo));
+            }
+
+            return idToQuestMap;
         }
-    }
 
-    private Quest LoadQuest(QuestInfoSO questInfo)
-    {
-        Quest quest = null;
-        try 
+        private Quest GetQuestById(string id)
+        {
+            Quest quest = questMap[id];
+            if (quest == null)
+            {
+                Debug.LogError("ID not found in the Quest Map: " + id);
+            }
+
+            return quest;
+        }
+
+        private void OnApplicationQuit()
+        {
+            foreach (Quest quest in questMap.Values)
+            {
+                SaveQuest(quest);
+            }
+        }
+
+        private void SaveQuest(Quest quest)
         {
-            // load quest from saved data
-            if (PlayerPrefs.HasKey(questInfo.id) && loadSavedQuestState)
+            try
             {
-                string serializedData = PlayerPrefs.GetString(questInfo.id);
-                QuestData questData = JsonUtility.FromJson<QuestData>(serializedData);
-                quest = new Quest(questInfo, questData.state, questData.questStepIndex, questData.questStepStates);
+                QuestData questData = quest.GetQuestData();
+                // serialize using JsonUtility, but use whatever you want here (like JSON.NET)
+                string serializedData = JsonUtility.ToJson(questData);
+                Debug.Log($"saved data {serializedData}");
+                // saving to PlayerPrefs is just a quick example for this tutorial video,
+                // you probably don't want to save this info there long-term.
+                // instead, use an actual Save & Load system and write to a file, the cloud, etc..
+                PlayerPrefs.SetString(quest.info.id, serializedData);
             }
-            // otherwise, initialize a new quest
-            else 
+            catch (System.Exception e)
             {
-                quest = new Quest(questInfo);
+                Debug.LogError("Failed to save quest with id " + quest.info.id + ": " + e);
             }
         }
-        catch (System.Exception e)
+
+        private Quest LoadQuest(QuestInfoSO questInfo)
         {
-            Debug.LogError("Failed to load quest with id " + quest.info.id + ": " + e);
+            Quest quest = null;
+            try
+            {
+                // load quest from saved data
+                if (PlayerPrefs.HasKey(questInfo.id) && loadSavedQuestState)
+                {
+                    string serializedData = PlayerPrefs.GetString(questInfo.id);
+                    QuestData questData = JsonUtility.FromJson<QuestData>(serializedData);
+                    quest = new Quest(questInfo, questData.state, questData.questStepIndex, questData.questStepStates);
+                }
+                // otherwise, initialize a new quest
+                else
+                {
+                    quest = new Quest(questInfo);
+                }
+            }
+            catch (System.Exception e)
+            {
+                Debug.LogError("Failed to load quest with id " + quest.info.id + ": " + e);
+            }
+
+            return quest;
         }
-        return quest;
     }
-}
+}

package/Runtime/Scripts/Core/QuestState.cs

@@ -2,11 +2,14 @@ using System.Collections;
 using System.Collections.Generic;
 using UnityEngine;
 
-public enum QuestState
+namespace jeanf.questsystem
 {
-    REQUIREMENTS_NOT_MET,
-    CAN_START,
-    IN_PROGRESS,
-    CAN_FINISH,
-    FINISHED
-}
+    public enum QuestState
+    {
+        REQUIREMENTS_NOT_MET,
+        CAN_START,
+        IN_PROGRESS,
+        CAN_FINISH,
+        FINISHED
+    }
+}

package/Runtime/Scripts/Core/QuestStep.cs

@@ -1,38 +1,48 @@
 using System.Collections;
 using System.Collections.Generic;
+using jeanf.EventSystem;
+using jeanf.propertyDrawer ;
 using UnityEngine;
+using jeanf.propertyDrawer;
 
-public abstract class QuestStep : MonoBehaviour
+namespace jeanf.questsystem
 {
-    private bool isFinished = false;
-    private string questId;
-    private int stepIndex;
-    private float questStepProgress = 0;
-
-    public void InitializeQuestStep(string questId, int stepIndex, string questStepState)
+    public abstract class QuestStep : MonoBehaviour
     {
-        this.questId = questId;
-        this.stepIndex = stepIndex;
-        if (questStepState != null && questStepState != "")
+        private bool isFinished = false;
+        private string questId;
+        private int stepIndex;
+        private float questStepProgress = 0;
+
+        [SerializeField] private bool sendEventOnInit = false;
+        //[DrawIf("sendEventOnInit", true, ComparisonType.Equals)] 
+
+        public void InitializeQuestStep(string questId, int stepIndex, string questStepState)
         {
-            SetQuestStepState(questStepState);
+            this.questId = questId;
+            this.stepIndex = stepIndex;
+            if (questStepState != null && questStepState != "")
+            {
+                SetQuestStepState(questStepState);
+            }
         }
-    }
 
-    protected void FinishQuestStep()
-    {
-        if (!isFinished)
+        protected void FinishQuestStep()
         {
-            isFinished = true;
-            GameEventsManager.instance.questEvents.AdvanceQuest(questId);
-            Destroy(this.gameObject);
+            if (!isFinished)
+            {
+                isFinished = true;
+                GameEventsManager.instance.questEvents.AdvanceQuest(questId);
+                Destroy(this.gameObject);
+            }
         }
-    }
 
-    protected void ChangeState(string newState)
-    {
-        GameEventsManager.instance.questEvents.QuestStepStateChange(questId, stepIndex, new QuestStepState(newState));
-    }
+        protected void ChangeState(string newState)
+        {
+            GameEventsManager.instance.questEvents.QuestStepStateChange(questId, stepIndex,
+                new QuestStepState(newState));
+        }
 
-    protected abstract void SetQuestStepState(string state);
-}
+        protected abstract void SetQuestStepState(string state);
+    }
+}

package/Runtime/Scripts/Core/QuestStepState.cs

@@ -2,18 +2,21 @@ using System.Collections;
 using System.Collections.Generic;
 using UnityEngine;
 
-[System.Serializable]
-public class QuestStepState
+namespace jeanf.questsystem
 {
-    public string state;
-
-    public QuestStepState(string state)
+    [System.Serializable]
+    public class QuestStepState
     {
-        this.state = state;
-    }
+        public string state;
 
-    public QuestStepState()
-    {
-        this.state = "";
+        public QuestStepState(string state)
+        {
+            this.state = state;
+        }
+
+        public QuestStepState()
+        {
+            this.state = "";
+        }
     }
-}
+}

package/Runtime/Scripts/Events/GameEventsManager.cs

@@ -1,29 +1,33 @@
 using System;
 using UnityEngine;
 
-public class GameEventsManager : MonoBehaviour
+namespace jeanf.questsystem
 {
-    public static GameEventsManager instance { get; private set; }
+    public class GameEventsManager : MonoBehaviour
+    {
+        public static GameEventsManager instance { get; private set; }
 
-    public InputEvents inputEvents;
-    public PlayerEvents playerEvents;
-    public ScenarioEvents scenarioEvents;
-    public MiscEvents miscEvents;
-    public QuestEvents questEvents;
+        public InputEvents inputEvents;
+        public PlayerEvents playerEvents;
+        public ScenarioEvents scenarioEvents;
+        public MiscEvents miscEvents;
+        public QuestEvents questEvents;
 
-    private void Awake()
-    {
-        if (instance != null)
+        private void Awake()
         {
-            Debug.LogError("Found more than one Game Events Manager in the scene.");
-        }
-        instance = this;
+            if (instance != null)
+            {
+                Debug.LogError("Found more than one Game Events Manager in the scene.");
+            }
 
-        // initialize all events
-        inputEvents = new InputEvents();
-        playerEvents = new PlayerEvents();
-        scenarioEvents = new ScenarioEvents();
-        miscEvents = new MiscEvents();
-        questEvents = new QuestEvents();
+            instance = this;
+
+            // initialize all events
+            inputEvents = new InputEvents();
+            playerEvents = new PlayerEvents();
+            scenarioEvents = new ScenarioEvents();
+            miscEvents = new MiscEvents();
+            questEvents = new QuestEvents();
+        }
     }
 }