net.dreditor.textdisplaying 0.0.0-stage → 0.1.6

package/TextDisplayDebugger.cs

@@ -0,0 +1,87 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Dialogues.LineReading;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using UnityEngine.InputSystem;
+
+namespace DREditor.TextDisplaying
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public class TextDisplayDebugger : MonoBehaviour
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected InputActionReference submit = null;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Space]
+        [Tooltip("")]
+        [SerializeField] protected bool debugging = true;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected List<Line> debugLines = new();
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected DialogueComponent lineDisplayerComponent;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected ILineTextDisplayRoutine lineTextDisplayer;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void Awake() => lineTextDisplayer = (ILineTextDisplayRoutine)lineDisplayerComponent;
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void Start() => StartCoroutine(LoopDebugDisplayLines());
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected virtual IEnumerator LoopDebugDisplayLines()
+        {
+            while (debugging)
+                yield return DisplayLines();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected virtual IEnumerator DisplayLines()
+        {
+            foreach(var line in debugLines)
+            {
+                yield return lineTextDisplayer.LineTextDisplay(line);
+
+                yield return null;
+
+                while (!submit.action.triggered && line.Text != "")
+                    yield return null;
+            }
+        }
+    }
+}

package/TextDisplayDebugger.cs.meta

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

package/TextDisplayModifier.cs

@@ -0,0 +1,29 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using TMPro;
+using UnityEngine;
+
+namespace DREditor.TextDisplaying
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public abstract class TextDisplayModifier : MonoBehaviour
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="text"></param>
+        /// <param name="currentLine"></param>
+        /// <param name="box"></param>
+        /// <returns></returns>
+        public abstract string ApplyModification(string text, Line currentLine = null, TMP_Text box = null);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="currentLine"></param>
+        /// <returns></returns>
+        public virtual bool SkipLine(Line currentLine) => false;
+    }
+}

package/TextDisplayModifier.cs.meta

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

package/TextDisplayer.cs

@@ -0,0 +1,255 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Dialogues.LineReading;
+using DREditor.EventObjects;
+using DREditor.Input;
+using DREditor.Services;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
+using TMPro;
+using UnityEngine;
+using UnityEngine.InputSystem;
+
+namespace DREditor.TextDisplaying
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [ClassHeader(nameof(TextDisplayerBase) + ", " + nameof(IToTitleScreen) + ", " + nameof(ILineRoutine) +
+        "\n\n")]
+    public class TextDisplayer : TextDisplayerBase
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected InputActionReference submit = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected BoolWithEvent inTrialMode = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected BoolWithEvent inFastForwardMode = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Tooltip("")]
+        [SerializeField] protected float bufferTextMultiplier = 0.01f;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        [Header("")]
+        [Divider]
+        [Tooltip("")]
+        [SerializeField] protected List<TextDisplayModifier> textModifiers = new();
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected bool skipText = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected bool skipTextStarted = false;
+
+        
+        /// <inheritdoc/>
+        public override void DisplayText(TMP_Text textBox, Line line)
+        {
+            if (inFastForwardMode.Value)
+            {
+                InitializeTextBox(textBox);
+
+                string preparedText = ApplyTextModifications(line);
+
+                PrepareTextBox(preparedText);
+
+                if (TextBoxIsEmpty(line))
+                    return;
+
+                ResolveDisplayingText(preparedText);
+            }
+            else
+                StartCoroutine(DisplayTextRoutine(textBox, line));
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="textBox"></param>
+        /// <param name="currentLine"></param>
+        /// <returns></returns>
+        protected virtual IEnumerator DisplayTextRoutine(TMP_Text textBox, Line currentLine)
+        {
+            InitializeTextBox(textBox);
+
+            string preparedText = ApplyTextModifications(currentLine);
+
+            PrepareTextBox(preparedText);
+
+            if (TextBoxIsEmpty(currentLine))
+                yield break;
+
+            yield return DisplayTextAnimation(preparedText);
+
+            ResolveDisplayingText(preparedText);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="textBox"></param>
+        protected virtual void InitializeTextBox(TMP_Text textBox)
+        {
+            box = textBox;
+
+            skipText = false;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="preparedText"></param>
+        protected virtual void PrepareTextBox(string preparedText)
+        {
+            box.maxVisibleCharacters = 0;
+
+            box.text = preparedText;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="currentLine"></param>
+        /// <returns></returns>
+        protected virtual bool TextBoxIsEmpty(Line currentLine)
+        {
+            bool result = string.IsNullOrEmpty(box.text) || SkipDisplayingLine(currentLine);
+
+            if (result)
+            {
+                SetWaitingForClick(false);
+
+                ServiceLocator.GetService<IInputManager>().Disable();
+
+                inFastForwardMode.SetValue(true);
+
+                ServiceLocator.GetService<IDialogueManager>()
+                .GetComponentsInChildren<MonoBehaviour>()
+                .OfType<ILineReader>()
+                .FirstOrDefault().OnLineEndEvent += OnLineSkipped;
+            }
+
+            return result;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void OnLineSkipped()
+        {
+            ServiceLocator.GetService<IDialogueManager>()
+                .GetComponentsInChildren<MonoBehaviour>()
+                .OfType<ILineReader>()
+                .FirstOrDefault().OnLineEndEvent -= OnLineSkipped;
+
+            inFastForwardMode.SetValue(false);
+
+            ServiceLocator.GetService<IInputManager>().Enable();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="currentLine"></param>
+        /// <returns></returns>
+        protected virtual string ApplyTextModifications(Line currentLine)
+        {
+            string preparedText = currentLine.Text;
+
+            foreach (var modifier in textModifiers)
+                preparedText = modifier.ApplyModification(preparedText, currentLine, box);
+
+            return preparedText;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="preparedText"></param>
+        /// <returns></returns>
+        protected virtual IEnumerator DisplayTextAnimation(string preparedText)
+        {
+            string textWithoutHTMLTags = Regex.Replace(preparedText, "<.*?>", string.Empty);
+
+            for (int i = 0; i < textWithoutHTMLTags.Length && !skipText; i++)
+            {
+                if (i == 1 && !skipTextStarted)
+                    StartCoroutine(SkipText());
+
+                box.maxVisibleCharacters = i;
+
+                if (!inFastForwardMode.Value)
+                    yield return new WaitForSecondsRealtime(textDisplaySpeed * bufferTextMultiplier);
+            }
+
+            box.maxVisibleCharacters += 1;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected virtual IEnumerator SkipText()
+        {
+            skipTextStarted = true;
+
+            while (IsWaitingForClick())
+                if (submit.action.triggered || inFastForwardMode.Value)
+                    break;
+                else
+                    yield return null;
+
+            skipTextStarted = false;
+
+            skipText = true;
+        }
+
+        /// <inheritdoc/>
+        public override bool ShouldProcess(Line currentLine)
+        {
+            foreach (var modifier in textModifiers)
+                if (modifier is ILineRoutine routineCheck && routineCheck.ShouldProcess(currentLine))
+                    return true;
+
+            return false;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="currentLine"></param>
+        /// <returns></returns>
+        protected virtual bool SkipDisplayingLine(Line currentLine)
+        {
+            foreach (var modifier in textModifiers)
+                if (modifier.SkipLine(currentLine))
+                    return true;
+
+            return false;
+        }
+    }
+}

package/TextDisplayer.cs.meta

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

package/TextDisplayerBase.cs

@@ -0,0 +1,107 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using DREditor.Dialogues;
+using DREditor.Dialogues.LineReading;
+using DREditor.Services;
+using TMPro;
+using UnityEngine;
+
+namespace DREditor.TextDisplaying
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public abstract class TextDisplayerBase : MonoBehaviour, IToTitleScreen, ILineRoutine
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        protected TMP_Text box = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected bool isWaitingForClick = false;
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected float textDisplaySpeed = 3.5f;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="textBox"></param>
+        /// <param name="line"></param>
+        public abstract void DisplayText(TMP_Text textBox, Line line);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="speed"></param>
+        public virtual void SetTextDisplaySpeed(float speed) => textDisplaySpeed = speed;
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="waitingForClick"></param>
+        public virtual void SetWaitingForClick(bool waitingForClick) => isWaitingForClick = waitingForClick;
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public virtual bool IsWaitingForClick() => isWaitingForClick;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="preparedText"></param>
+        public virtual void ResolveDisplayingText(string preparedText)
+        {
+            if (box != null)
+                PasteFinalDisplayText(preparedText);
+
+            SetWaitingForClick(false);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <param name="text"></param>
+        protected virtual void PasteFinalDisplayText(string text)
+        {
+            box.text = text;
+
+            box.maxVisibleCharacters = int.MaxValue;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public virtual string GetText() => box != null ? box.text : "";
+
+
+        /// <inheritdoc/>
+        public abstract bool ShouldProcess(Line currentLine);
+
+
+        /// <inheritdoc/>
+        public virtual void ToTitleScreen() => ClearText();
+
+        /// <summary>
+        ///
+        /// </summary>
+        public virtual void ClearText()
+        {
+            if (box != null)
+            {
+                box.maxVisibleCharacters = 0;
+
+                box.text = "";
+            }
+        }
+    }
+}

package/TextDisplayerBase.cs.meta

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

package/package.json

@@ -1,6 +1,37 @@
-{
-  "name": "net.dreditor.textdisplaying",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "net.dreditor.textdisplaying",
+  "version": "0.1.6",
+  "displayName": "DREditor Text Displaying",
+  "description": "The beta for DREditor. A tool to create death game style projects without having to code.",
+  "unity": "6000.4",
+  "dependencies": {
+    "com.unity.inputsystem": "1.19.0",
+    "com.unity.ugui": "2.0.0",
+    "net.dreditor.core": "0.1.6",
+    "net.dreditor.input": "0.1.6"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": {
+    "name": "Benjamin \"Sweden\" Jillson",
+    "email": "dreditortool@gmail.com",
+    "url": "https://dreditor.net"
+  },
+  "keywords": [
+    "editor",
+    "tool",
+    "dreditor"
+  ],
+  "samples": [
+    {
+      "displayName": "Samples",
+      "description": "",
+      "path": "Samples~"
+    }
+  ],
+  "documentationUrl": "https://dreditor.net",
+  "license": "Apache-2.0",
+  "licensesUrl": "https://dreditor.net/docs/LICENSE.html",
+  "changelogUrl": "https://dreditor.net/docs/CHANGELOG.html"
+}

package/package.json.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 4a7aa825c8c21c1428c156343b6635ee
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.