net.dreditor.backlog 0.0.0-stage → 0.1.6

package/BacklogHandler.cs

@@ -0,0 +1,53 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Saving;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace DREditor.Backlogging
+{
+    /// <summary>
+    ///
+    /// </summary>
+	[ClassHeader("")]
+    public class BacklogHandler : BacklogHandlerBase, IDRESaveable, IDRELoadable
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Backlog backlog = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected string dataSaveKey = "BackData";
+
+
+        /// <inheritdoc/>
+        public override object[] GetBacklogLines() => backlog.GetLinesArray();
+
+        /// <inheritdoc/>
+        public override void ClearLines() => backlog.Lines.Clear();
+
+        /// <inheritdoc/>
+        public override void AddLine(object o = null)
+        {
+            if (o != null && o is BacklogLines line)
+                backlog.AddLine(line.Charfile, line.Text, line.AliasNum, line.Color, line.Voice);
+        }
+
+        /// <inheritdoc/>
+        public override object SaveBacklog() => backlog.Save();
+
+        /// <inheritdoc/>
+        public override void LoadBacklog(object o = null) => backlog.Load((BacklogData)o);
+
+        /// <inheritdoc/>
+        public virtual void Save(Dictionary<string, object> saveData) => saveData.Set(dataSaveKey, (BacklogData)SaveBacklog());
+
+        /// <inheritdoc/>
+        public virtual void Load(Dictionary<string, object> saveDatas) => LoadBacklog(saveDatas.Get<BacklogData>(dataSaveKey));
+    }
+}

package/BacklogHandler.cs.meta

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

package/BacklogHandlerBase.cs

@@ -0,0 +1,93 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.EventObjects;
+using DREditor.Services;
+using UnityEngine;
+
+namespace DREditor.Backlogging
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public abstract class BacklogHandlerBase : MonoBehaviour, ISceneEventListener
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected SceneEvent startedNewGame = null;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void OnEnable()
+        {
+            RegisterThisService();
+
+            startedNewGame.RegisterListener(this);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void OnDisable()
+        {
+            UnregisterThisService();
+
+            startedNewGame.UnregisterListener(this);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void RegisterThisService()
+        {
+            if (!ServiceLocator.HasService<BacklogHandlerBase>())
+                ServiceLocator.Register(this);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void UnregisterThisService()
+        {
+            if (ServiceLocator.GetService<BacklogHandlerBase>() == this)
+                ServiceLocator.Unregister(this);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public abstract object[] GetBacklogLines();
+
+        /// <summary>
+        ///
+        /// </summary>
+        public abstract void ClearLines();
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="o"></param>
+        public abstract void AddLine(object o = null);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public abstract object SaveBacklog();
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="o"></param>
+        public abstract void LoadBacklog(object o = null);
+
+
+        /// <inheritdoc/>
+        public virtual void OnEventRaised() => ClearLines();
+    }
+}

package/BacklogHandlerBase.cs.meta

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

package/BacklogLineHandler.cs

@@ -0,0 +1,47 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Dialogues.LineReading;
+using DREditor.Services;
+using DREditor.TextDisplaying;
+
+namespace DREditor.Backlogging
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(ILineEndProcess) + 
+        "\n\n")]
+    public class BacklogLineHandler : DialogueComponent, ILineEndProcess
+    {
+        /// <inheritdoc/>
+        public virtual void LineEndProcess(Line currentLine) => AddLineToBacklog(currentLine);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="currentLine"></param>
+        protected virtual void AddLineToBacklog(Line currentLine)
+        {
+            if (currentLine.Speaker != null)
+                ServiceLocator.GetService<BacklogHandlerBase>().AddLine(CreateBacklogLine(currentLine));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="currentLine"></param>
+        /// <returns></returns>
+        protected virtual BacklogLines CreateBacklogLine(Line currentLine) =>
+            new(
+                currentLine.Speaker,
+                ServiceLocator.GetService<ITextDisplayerHandler>().GetTextBox().text,
+                currentLine.AliasNumber - 1,
+#if FMOD_UNITY
+                currentLine.VoiceSFX,
+#else
+                currentLine.VoiceSFX.name,
+#endif
+                ServiceLocator.GetService<ITextDisplayerHandler>().GetTextBox().color
+                );
+    }
+}

package/BacklogLineHandler.cs.meta

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

package/BacklogSlot.cs

@@ -0,0 +1,252 @@
+// Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+// Original Author: LeotheDev
+using DREditor.Characters;
+using DREditor.Dialogues;
+using DREditor.UI;
+using System.Linq;
+using TMPro;
+using UnityEngine;
+using UnityEngine.UI;
+
+namespace DREditor.Backlogging
+{
+    /// <summary>
+    ///
+    /// </summary>
+	[ClassHeader("")]
+    public class BacklogSlot : MonoBehaviour, IGridIconSlot
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected CharacterDatabase characterDatabase = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Backlog backlog = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected string headmasterFirstName = "Tozu";
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] private BacklogMugBind[] Mugshots;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected GameObject voiceIcon = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Image overlayImage = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Sprite overlayOn;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Sprite overlayOff;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected TextMeshProUGUI backlogText = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected Image mugshotImage = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected RawImage nameplate = null;
+
+
+        /// <inheritdoc/>
+        public virtual void ClearSlotState() => DisplayEmptyBacklogEntry();
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void DisplayEmptyBacklogEntry()
+        {
+            mugshotImage.gameObject.SetActive(false);
+
+            overlayImage.sprite = overlayOff;
+
+            nameplate.gameObject.SetActive(false);
+
+            voiceIcon.SetActive(false);
+
+            backlogText.text = string.Empty;
+        }
+
+        
+        /// <inheritdoc/>
+        public virtual void UpdateSlot(int globalIndex, bool selected)
+            => UpdateBacklogSlot(backlog.Lines.ToArray().Reverse().ToArray()[globalIndex], selected);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="entry"></param>
+        /// <param name="localSelected"></param>
+        protected virtual void UpdateBacklogSlot(BacklogLines entry, bool localSelected)
+        {
+            Character character = characterDatabase.GetCharacter(entry.CharFirstName);
+
+            if (character == null)
+                return;
+
+            EvaluateMugshot(character, localSelected, entry.AliasNum);
+
+            nameplate.gameObject.SetActive(true);
+
+            nameplate.texture = entry.AliasNum != -1
+                ? characterDatabase.GetCharacter(entry.CharFirstName).Aliases[entry.AliasNum].Nameplate
+                : characterDatabase.GetCharacter(entry.CharFirstName).Nameplate;
+
+            overlayImage.sprite = localSelected ? overlayOn : overlayOff;
+
+            backlogText.text = entry.Text;
+
+            backlogText.color = entry.Color;
+
+            voiceIcon.SetActive(!string.IsNullOrEmpty(entry.Voice));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="character"></param>
+        /// <param name="localSelected"></param>
+        /// <param name="entryAliasNum"></param>
+        protected virtual void EvaluateMugshot(Character character, bool localSelected, int entryAliasNum)
+        {
+            if (MugshotValid())
+                PopulateMugshot(character, localSelected, entryAliasNum);
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <returns></returns>
+        protected virtual bool MugshotValid() => Mugshots != null && Mugshots.Length != 0;
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="character"></param>
+        /// <param name="localSelected"></param>
+        /// <param name="entryAliasNum"></param>
+        protected virtual void PopulateMugshot(Character character, bool localSelected, int entryAliasNum)
+        {
+            BacklogMugBind mug = Mugshots.First(f => f != null && f.charaName == character.FirstName);
+
+            if (mug != null && mug.Mug_ON != null && mug.Mug_OFF != null)
+            {
+                mugshotImage.gameObject.SetActive(true);
+
+                mugshotImage.sprite = localSelected ? mug.Mug_ON : mug.Mug_OFF;
+
+                mugshotImage.transform.SetSiblingIndex(localSelected ? mugshotImage.transform.parent.childCount : 0);
+            }
+
+            if (mug == null || (character.FirstName == headmasterFirstName && entryAliasNum == 0))
+                mugshotImage.gameObject.SetActive(false);
+        }
+
+#if UNITY_EDITOR
+        /// <summary>
+        ///
+        /// </summary>
+        [ContextMenu("Generate Mugshot List")]
+        public void GenerateMugshotList()
+        {
+            if (characterDatabase != null)
+            {
+                Mugshots = new BacklogMugBind[characterDatabase.Characters.Count];
+
+                for (int i = 0; i < characterDatabase.Characters.Count; i++)
+                    Mugshots[i] = new(characterDatabase.Characters[i].FirstName, UnityEditor.Selection.objects);
+            }
+            else
+                UnityEngine.Debug.LogWarning("ALERT: Must have Character Database assigned.");
+        }
+#endif
+
+        /// <summary>
+        ///
+        /// </summary>
+        [System.Serializable]
+        sealed class BacklogMugBind
+        {
+            /// <summary>
+            ///
+            /// </summary>
+            [Tooltip("")]
+            [SerializeField] internal string charaName;
+
+            /// <summary>
+            ///
+            /// </summary>
+            [Tooltip("")]
+            [SerializeField] internal Sprite Mug_ON;
+
+            /// <summary>
+            ///
+            /// </summary>
+            [Tooltip("")]
+            [SerializeField] internal Sprite Mug_OFF;
+
+            /// <summary>
+            ///
+            /// </summary>
+            /// <param name="charaName"></param>
+            /// <param name="objects"></param>
+            internal BacklogMugBind(string charaName, Object[] objects)
+            {
+                this.charaName = charaName;
+
+                UnityEngine.Debug.Log(nameof(BacklogMugBind) + ": Note when importing. " +
+                    "Ensure you select all the headshot images of all characters so that they can be assigned.");
+
+                UnityEngine.Debug.Log(nameof(BacklogMugBind) + ": Note when importing. Ensure that the names of the mug shot sprites " +
+                    "contain the characters name, and the words \"Selected\" or \"Unselected\" for proper importing.");
+
+                foreach (var sprite in objects)
+                    if (sprite.name.Contains(charaName))
+                        if (sprite.name.Contains("Unselected"))
+                            Mug_OFF = (Sprite)sprite;
+                        else
+                            Mug_ON = (Sprite)sprite;
+            }
+        }
+    }
+}

package/BacklogSlot.cs.meta

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