同步

Packages/dev.yarnspinner.unity/Editor/Templates/DialoguePresenterTemplate.txt

@@ -0,0 +1,94 @@
+using System.Threading;
+using System.Collections.Generic;
+using UnityEngine;
+using Yarn;
+using Yarn.Unity;
+
+#nullable enable
+
+public class #SCRIPTNAME# : DialoguePresenterBase
+{
+    public override async YarnTask OnDialogueStartedAsync()
+    {
+        // Called by the Dialogue Runner to signal that dialogue has just
+        // started up.
+        //
+        // You can use this method to prepare for presenting dialogue, like
+        // changing the camera, fading up your on-screen UI, or other tasks.
+        //
+        // The Dialogue Runner will wait until every Presenter returns from
+        // this method before delivering any content.
+    }
+
+    public override async YarnTask OnDialogueCompleteAsync()
+    {
+        // Called by the Dialogue Runner to signal that dialogue has ended.
+        //
+        // You can use this method to clean up after running dialogue, like
+        // changing the camera back, fading away on-screen UI, or other tasks.
+    }
+
+    public override async YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)
+    {
+        // Called by the Dialogue Runner to signal that a line of dialogue
+        // should be shown to the player.
+        //
+        // If your presenter handles lines, it should take the 'line'
+        // parameter and use the information inside it to present the content to
+        // the player, in whatever way makes sense.
+        //
+        // Some useful information:
+        // - The 'Text' property in 'line' contains the parsed, localised text
+        //   of the line, including attributes and text.
+        // - The 'TextWithoutCharacterName' property contains all of the text
+        //   after the character name in the line (if present), and the
+        //   'CharacterName' contains the character name (if present).
+        // - The 'Asset' property contains whatever object was associated with
+        //   this line, as provided by your Dialogue Runner's Line Provider.
+        //
+        // The LineCancellationToken contains information on whether the
+        // Dialogue Runner wants this Presenter to hurry up its
+        // presentation, or to advance to the next line. 
+        //
+        // - If 'token.IsHurryUpRequested' is true, that's a hint that your view
+        //   should speed up its delivery of the line, if possible (for example,
+        //   by displaying text faster). 
+        // - If 'token.IsNextContentRequested' is true, that's an instruction that
+        //   your view must end its presentation of the line as fast as possible
+        //   (even if that means ending the delivery early.)
+        //
+        // The Dialogue Runner will wait for all Presenters to return from
+        // this method before delivering new content.
+        //
+        // If your Dialogue Presenters doesn't need to handle lines, simply return
+        // from this method immediately.
+    }
+
+    public override async YarnTask<DialogueOption?> RunOptionsAsync(DialogueOption[] dialogueOptions, LineCancellationToken cancellationToken)
+    {
+        // Called by the Dialogue Runner to signal that options should be shown
+        // to the player.
+        //
+        // If your Dialogue Presenter handles options, it should present them to the
+        // player and await a selection. Once a choice has been made, it should
+        // return the appropriate element from dialogueOptions.
+        //
+        // The LineCancellationToken contains information on whether the
+        // Dialogue Runner wants this Presenter to hurry up its
+        // presentation, or to advance to the next piece of content. 
+        //
+        // - If 'token.IsHurryUpRequested' is true, that's a hint that your view
+        //   should speed up its delivery of the options, if possible (for example,
+        //   by fading up text faster). 
+        // - If 'token.IsNextContentRequested' is true, that's an instruction that
+        //   your view must end handling options and return null as soon as possible.
+        //
+        // The Dialogue Runner will wait for all Dialogue Presenters to return from
+        // this method before delivering new content.
+        //
+        // If your Dialogue Presenter doesn't need to handle options, simply
+        // delete this method.
+
+        return null;
+    }
+}