Add OnDialogueStartedAsync; Dialogue Runner now waits for all views t…

…o report ready before delivering content
YarnSpinnerTool · May 21, 2024 · 04e3cea · 04e3cea
1 parent 3154828
commit 04e3cea
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 5 deletions.
diff --git a/Runtime/Async/AsyncDialogueViewBase.cs b/Runtime/Async/AsyncDialogueViewBase.cs
@@ -25,7 +25,8 @@ public abstract class AsyncDialogueViewBase : MonoBehaviour
  {
  public abstract YarnTask RunLineAsync(LocalizedLine line, CancellationToken token);
  public abstract YarnOptionTask RunOptionsAsync(DialogueOption[] dialogueOptions, CancellationToken cancellationToken);
- public abstract YarnTask DialogueCompleteAsync();
+ public abstract YarnTask OnDialogueStartedAsync();
+ public abstract YarnTask OnDialogueCompleteAsync();
 
  public virtual bool EndLineWhenViewFinishes => false;
  }

diff --git a/Runtime/DialogueRunner.cs b/Runtime/DialogueRunner.cs
@@ -291,7 +291,7 @@ async YarnTask RunCompletion()
  {
  try
  {
- await view.DialogueCompleteAsync();
+ await view.OnDialogueCompleteAsync();
  }
  catch (System.Exception e)
  {
@@ -615,7 +615,22 @@ public void StartDialogue(string nodeName)
 
  onDialogueStart?.Invoke();
 
- Dialogue.Continue();
+ StartDialogueAsync().Forget();
+
+ async YarnTask StartDialogueAsync()
+ {
+ var tasks = new List<YarnTask>();
+ foreach (var view in DialogueViews)
+ {
+ if (view == null)
+ {
+ continue;
+ }
+ tasks.Add(view.OnDialogueStartedAsync());
+ }
+ await YarnTask.WhenAll(tasks);
+ Dialogue.Continue();
+ }
  }
 
  public void CancelCurrentLine()

diff --git a/Runtime/Views/DialogueViewBase.cs b/Runtime/Views/DialogueViewBase.cs
@@ -380,7 +380,12 @@ public virtual void UserRequestedViewAdvancement()
  // default implementation does nothing
  }
 
- public override YarnTask DialogueCompleteAsync()
+ public override YarnTask OnDialogueStartedAsync()
+ {
+ return YarnTask.CompletedTask;
+ }
+
+ public override YarnTask OnDialogueCompleteAsync()
  {
  return YarnTask.CompletedTask;
  }

diff --git a/Tests/Runtime/DialogueRunnerTests/DialogueRunnerMockUI.cs b/Tests/Runtime/DialogueRunnerTests/DialogueRunnerMockUI.cs
@@ -163,7 +163,12 @@ public override async YarnOptionTask RunOptionsAsync(DialogueOption[] dialogueOp
  return dialogueOptions[selectedOption];
  }
 
- public override YarnTask DialogueCompleteAsync()
+ public override YarnTask OnDialogueStartedAsync()
+ {
+ return YarnTask.CompletedTask;
+ }
+
+ public override YarnTask OnDialogueCompleteAsync()
  {
  return YarnTask.CompletedTask;
  }