Improve performance of RichLabel, add AppendText, adapt Typewriter to append text rather than deal with precomputed labels AscensionGameDev#2565

Author: pandinocoder

Framework/Intersect.Framework.Core/Configuration/ClientConfiguration.cs

@@ -61,23 +61,23 @@ public static ClientConfiguration LoadAndSave(string? filePath = default) =>
 
     public const bool DefaultTypewriterEnabled = true;
 
-    public static List<char> DefaultTypewriterFullStopCharacters =>
+    public static HashSet<string> DefaultTypewriterFullStops =>
     [
-        '.',
-        '!',
-        '?',
-        ':',
+        ".",
+        "!",
+        "?",
+        ":",
     ];
 
     public const long DefaultTypewriterFullStopDelay = 400;
 
     public const long DefaultTypewriterPartDelay = 6;
 
-    public static List<char> DefaultTypewriterPauseCharacters =>
+    public static HashSet<string> DefaultTypewriterPauses =>
     [
-        ',',
-        ';',
-        '-',
+        ",",
+        ";",
+        "-",
     ];
 
     public const long DefaultTypewriterPauseDelay = 80;
@@ -115,8 +115,8 @@ public void Validate()
               },
         ];
         Port = Math.Min(Math.Max(Port, (ushort)1), ushort.MaxValue);
-        TypewriterFullStopCharacters = TypewriterFullStopCharacters?.Distinct()?.ToList() ?? [];
-        TypewriterPauseCharacters = TypewriterPauseCharacters?.Distinct()?.ToList() ?? [];
+        TypewriterFullStops ??= [];
+        TypewriterPauses ??= [];
         TypewriterSounds = [..TypewriterSounds?.Distinct() ?? new List<string>()];
         UIFont = string.IsNullOrWhiteSpace(UIFont) ? DefaultUIFont : UIFont.Trim();
     }
@@ -240,13 +240,13 @@ public void Validate()
 
     public bool TypewriterEnabled { get; set; } = DefaultTypewriterEnabled;
 
-    public List<char> TypewriterFullStopCharacters { get; set; } = DefaultTypewriterFullStopCharacters;
+    public HashSet<string> TypewriterFullStops { get; set; } = DefaultTypewriterFullStops;
 
     public long TypewriterFullStopDelay { get; set; } = DefaultTypewriterFullStopDelay;
 
     public long TypewriterPartDelay { get; set; } = DefaultTypewriterPartDelay;
 
-    public List<char> TypewriterPauseCharacters { get; set; } = DefaultTypewriterPauseCharacters;
+    public HashSet<string> TypewriterPauses { get; set; } = DefaultTypewriterPauses;
 
     public long TypewriterPauseDelay { get; set; } = DefaultTypewriterPauseDelay;
 

Intersect.Client.Core/Interface/Game/EventWindow.cs

@@ -30,17 +30,16 @@ public partial class EventWindow : Panel
     private readonly Panel _optionsPanel;
     private readonly Button[] _optionButtons = new Button[4];
 
-    private readonly Typewriter? _writer;
-    private bool _isTypewriting;
+    private readonly bool _typewriting;
     private readonly long _typewriterResponseDelay = ClientConfiguration.Instance.TypewriterResponseDelay;
+    private readonly Typewriter? _writer;
 
     private readonly Dialog _dialog;
 
     private EventWindow(Canvas gameCanvas, Dialog dialog) : base(gameCanvas, nameof(EventWindow))
     {
         _dialog = dialog;
         _defaultFont = GameContentManager.Current.GetFont(name: "sourcesansproblack", 12);
-        _writer = Globals.Database.TypewriterBehavior == TypewriterBehavior.Off ? default : new Typewriter();
 
         Alignment = [Alignments.Center];
         MinimumSize = new Point(520, 180);
@@ -159,7 +158,28 @@ private EventWindow(Canvas gameCanvas, Dialog dialog) : base(gameCanvas, nameof(
         // LoadJsonUi(GameContentManager.UI.InGame, Graphics.Renderer?.GetResolutionString());
 
         SkipRender();
-        ShowDialog();
+
+        _promptLabel.ClearText();
+        _promptLabel.AddText(_dialog.Prompt ?? string.Empty, _promptTemplateLabel);
+        _promptLabel.ForceImmediateRebuild();
+        _ = _promptLabel.SizeToChildren();
+
+        _typewriting = ClientConfiguration.Instance.TypewriterEnabled &&
+                       Globals.Database.TypewriterBehavior != TypewriterBehavior.Off;
+        if (_typewriting)
+        {
+            _promptLabel.ClearText();
+            _writer = new Typewriter(_dialog.Prompt ?? string.Empty, text => _promptLabel.AppendText(text, _promptTemplateLabel));
+        }
+
+        Defer(
+            () =>
+            {
+                SizeToChildren(recursive: true);
+
+                _promptScroller.ScrollToTop();
+            }
+        );
 
         MakeModal(dim: true);
         BringToFront();
@@ -185,41 +205,43 @@ public override void Dispose()
 
     private void Update()
     {
-        // Handle typewriting
-        if (_isTypewriting && IsVisible)
+        if (!IsVisible || !_typewriting)
         {
-            var voiceIdx = Randomization.Next(0, ClientConfiguration.Instance.TypewriterSounds.Count);
+            return;
+        }
 
-            // Always show option 1 ("continue" if options empty)
-            var writerCompleted = _writer?.IsDone ?? true;
-            for (var optionIndex = 0; optionIndex < _optionButtons.Length; ++optionIndex)
-            {
-                var optionButton = _optionButtons[optionIndex];
-                var optionText = _dialog?.Options[optionIndex];
-                optionButton.IsVisible = writerCompleted && !string.IsNullOrEmpty(optionText);
-            }
+        if (_writer is null)
+        {
+            return;
+        }
 
-            _writer?.Write(ClientConfiguration.Instance.TypewriterSounds.ElementAtOrDefault(voiceIdx));
-            if (writerCompleted)
-            {
-                var disableResponse = _writer != default &&
-                                      Timing.Global.MillisecondsUtc - _writer.DoneAtMilliseconds <
-                                      _typewriterResponseDelay;
-                foreach (var optionButton in _optionButtons)
-                {
-                    optionButton.IsDisabled = disableResponse;
-                }
-            }
-            else if (Controls.IsControlPressed(Control.AttackInteract))
-            {
-                SkipTypewriting();
-            }
+        var writerCompleted = _writer.IsDone;
 
-            return;
+        foreach (var optionButton in _optionButtons)
+        {
+            optionButton.IsVisible = writerCompleted && !string.IsNullOrEmpty(optionButton.Text);
         }
 
-        _isTypewriting = ClientConfiguration.Instance.TypewriterEnabled &&
-                         Globals.Database.TypewriterBehavior == TypewriterBehavior.Word;
+        if (writerCompleted)
+        {
+            var disableResponse = Timing.Global.MillisecondsUtc - _writer.DoneAtMilliseconds <
+                                  _typewriterResponseDelay;
+            foreach (var optionButton in _optionButtons)
+            {
+                optionButton.IsDisabled = disableResponse;
+            }
+        }
+        else if (Controls.IsControlPressed(Control.AttackInteract))
+        {
+            SkipTypewriting();
+            _promptScroller.ScrollToBottom();
+        }
+        else
+        {
+            var soundIndex = Randomization.Next(0, ClientConfiguration.Instance.TypewriterSounds.Count);
+            _writer.Write(ClientConfiguration.Instance.TypewriterSounds.ElementAtOrDefault(soundIndex));
+            _promptScroller.ScrollToBottom();
+        }
     }
 
     public static void ShowOrUpdateDialog(Canvas canvas)
@@ -239,33 +261,6 @@ public static void ShowOrUpdateDialog(Canvas canvas)
         _instance = new EventWindow(canvas, availableDialog);
     }
 
-    private void ShowDialog()
-    {
-        _promptLabel.ClearText();
-        _promptLabel.AddText(_dialog?.Prompt ?? string.Empty, _promptTemplateLabel);
-
-        _ = _promptLabel.SizeToChildren();
-
-        // Do this _after_ sizing so we have lines broken up
-        if (_isTypewriting)
-        {
-            _writer?.Initialize(_promptLabel.FormattedLabels);
-            foreach (var button in _optionButtons)
-            {
-                button.Hide();
-            }
-        }
-
-        Defer(
-            () =>
-            {
-                SizeToChildren(recursive: true);
-
-                _promptScroller.ScrollToTop();
-            }
-        );
-    }
-
     public void CloseEventResponse(EventResponseType response)
     {
         if (!(_writer?.IsDone ?? true))