v0.3.20 - YarnSpinner libraries v3.2.0 , YSLS JSON generation, new Typewriter API (#118)

* WIP update to yarnspinner 3.2.0 libs

* workaround for dialogue hanging in YS 3.1+: wait a frame at the end of commands

* porting source generator changes

* remove references to UNITY_EDITOR

* remove unused unity addressables code

* fix some references to unity

* YSLS source generation working!

* commit generated ysls

* remove temp code

* revise pending version number to 0.3.20

* Register `CustomMarker` and `BasicMarker` as custom types for better editor integration (fix #119)

* updated ysls json

* settings.json

* remove duplicate emission of onDialogueComplete signal

* update changelog.md

* - Add dialogueRunner.allowOptionFallthrough which allows dialogue to proceed when no dialogue options were chosen https://yarnspinner.dev/blog/yarn-spinner-3-1-release/#dialogue-option-fallthrough

* port relative path changes for ysls from unity update

* add typewriter changes ported from YS-Unity

* consider no options to have been selected if no options are visible in OptionsPresenter

* reorder comment

* revert change to how paths are made relative which seems to have broken YSLS generation

* - To disable generation of the YSLS file, add the define symbol . Example in your `.csproj` file: `<DefineConstants>$(DefineConstants);YARN_SOURCE_GENERATION_DISABLE_YSLS</DefineConstants>`
- You can now also disable source generation entirely if desired with the symbol `YARN_SOURCE_GENERATION_DISABLE_ALL`. This will prevent you from using the `[YarnCommand]` and `[YarnFunction]` attributes and require manual command and function registration to each dialogue runner.

* fix #121 - showCharacterNameInLineView logic

* update changelog.md

---------

Co-authored-by: dogboydog <6483507-dogboydog@users.noreply.gitlab.com>

Author: dogboydog

.github/workflows/continuous_build_check.yaml

@@ -43,7 +43,7 @@ jobs:
       - uses: chickensoft-games/setup-godot@v1
         name: 🤖 Setup Godot
         with:
-          version: 4.6.0
+          version: 4.6.2
           # Use .NET-enabled version of Godot (the default is also true).
           use-dotnet: true
           include-templates: true

.vscode/settings.json

@@ -0,0 +1,59 @@
+{
+  "cSpell.enableFiletypes": [
+    "yarnspinner"
+  ],
+  "cSpell.languageSettings": [
+    {
+      "languageId": "yarnspinner",
+      "patterns": [
+        {
+          "name": "yarn-commands",
+          "pattern": "/<<[^>]*>>/g"
+        },
+        {
+          "name": "yarn-expressions",
+          "pattern": "/\\{[^}]*\\}/g"
+        },
+        {
+          "name": "yarn-variables",
+          "pattern": "/\\$[a-zA-Z_][a-zA-Z0-9_]*/g"
+        },
+        {
+          "name": "yarn-markup",
+          "pattern": "/\\[[^\\]]*\\]/g"
+        },
+        {
+          "name": "yarn-hashtags",
+          "pattern": "/#[a-zA-Z_][a-zA-Z0-9_:-]*/g"
+        },
+        {
+          "name": "yarn-node-markers",
+          "pattern": "/^(---|===)$/gm"
+        },
+        {
+          "name": "yarn-headers",
+          "pattern": "/^(title|tags|position|color|colorID|tracking|custom|style):.*/gm"
+        },
+        {
+          "name": "yarn-character-names",
+          "pattern": "/^\\s*[A-Za-z_][A-Za-z0-9_]*(?=:)/gm"
+        },
+        {
+          "name": "yarn-comments",
+          "pattern": "/\\/\\/.*$/gm"
+        }
+      ],
+      "ignoreRegExpList": [
+        "yarn-commands",
+        "yarn-expressions",
+        "yarn-variables",
+        "yarn-markup",
+        "yarn-hashtags",
+        "yarn-node-markers",
+        "yarn-headers",
+        "yarn-character-names",
+        "yarn-comments"
+      ]
+    }
+  ]
+}

CHANGELOG.md

@@ -40,22 +40,26 @@ public override void _Ready()
         LineProvider.RegisterMarkerProcessor("img", this);
     }
 
-    public override List<LineParser.MarkupDiagnostic> ProcessReplacementMarker(MarkupAttribute marker,
-        StringBuilder childBuilder, List<MarkupAttribute> childAttributes,
-        string localeCode)
+    public override ReplacementMarkerResult ProcessReplacementMarker(MarkupAttribute marker,
+           StringBuilder childBuilder, List<MarkupAttribute> childAttributes,
+           string localeCode)
     {
         if (_aliasToSpritePath.TryGetValue(marker.Name, out var value))
         {
             // replace with <image tag> 
             childBuilder.Insert(0, value);
-            return [];
+            return new ReplacementMarkerResult(value.Length);
         }
 
         if (marker.Name == "img")
         {
             if (!marker.TryGetProperty("path", out MarkupValue imagePath))
             {
-                return [new("No path attribute specified for img markup tag.")];
+                var error = new List<LineParser.MarkupDiagnostic>
+                {
+                    new LineParser.MarkupDiagnostic("No path attribute specified for img markup tag.")
+                };
+                return new ReplacementMarkerResult(error, 0);
             }
 
             var widthString = "";
@@ -74,10 +78,11 @@ public override void _Ready()
 
             // generic image markup
             childBuilder.Insert(0, $"[img{argsString}]res://Samples/Markup/images/{imagePath.StringValue}[/img]");
-
-            return NoDiagnostics;
+            var finalString = $"[img{argsString}]res://Samples/Markup/images/{imagePath.StringValue}[/img]";
+            childBuilder.Insert(0, finalString);
+            return new ReplacementMarkerResult(finalString.Length);
         }
 
-        return [];
+        return new ReplacementMarkerResult();
     }
 }

Samples/Markup/ImageMarkupProcessor.cs

@@ -1,10 +1,10 @@
 {
-  "projectFileVersion": 3,
-  "sourceFiles": [
-    "**/*.yarn"
-  ],
-  "excludeFiles": [],
-  "localisation": {},
-  "baseLanguage": "en",
-  "compilerOptions": {}
+    "projectFileVersion": 3,
+    "sourceFiles": [
+        "**/*.yarn"
+    ],
+    "excludeFiles": [],
+    "localisation": {},
+    "baseLanguage": "en",
+    "compilerOptions": {}
 }

Samples/Markup/Markup.yarnproject

@@ -1,4 +1,4 @@
-[gd_resource type="Resource" script_class="MarkupPalette" load_steps=10 format=3 uid="uid://c631us202ijmk"]
+[gd_resource type="Resource" script_class="MarkupPalette" format=3 uid="uid://c631us202ijmk"]
 
 [ext_resource type="Script" uid="uid://b3q2v7wyxccs0" path="res://addons/YarnSpinner-Godot/Runtime/BasicMarker.cs" id="1_n23v5"]
 [ext_resource type="Script" uid="uid://lvtve3yjd8v7" path="res://addons/YarnSpinner-Godot/Runtime/CustomMarker.cs" id="2_1n8i4"]

Samples/Markup/example_markup_palette.tres

@@ -1,11 +1,11 @@
-[gd_scene load_steps=5 format=3 uid="uid://dnyy064638ly1"]
+[gd_scene format=3 uid="uid://dnyy064638ly1"]
 
 [ext_resource type="Script" uid="uid://0y1x11g66ue4" path="res://Samples/SampleEntryPoint.cs" id="1"]
 [ext_resource type="Theme" uid="uid://b2mp0b1wvnu8s" path="res://Samples/sample_default_theme.tres" id="2"]
 [ext_resource type="Script" uid="uid://c3xcfucrfxoia" path="res://Samples/SampleVersionNumberLabel.cs" id="2_shsu2"]
 [ext_resource type="Texture2D" uid="uid://pbrr5yyepbx8" path="res://addons/YarnSpinner-Godot/Editor/Icons/YarnSpinnerLogo.png" id="3_bcudv"]
 
-[node name="SampleEntryPoint" type="CanvasLayer" node_paths=PackedStringArray("_spaceButton", "_visualNovelButton", "_markupPaletteButton", "_pausingTypewriterButton", "_roundedViewsButton", "_sqliteButton", "_gdscriptButton")]
+[node name="SampleEntryPoint" type="CanvasLayer" unique_id=501891245 node_paths=PackedStringArray("_spaceButton", "_visualNovelButton", "_markupPaletteButton", "_pausingTypewriterButton", "_roundedViewsButton", "_sqliteButton", "_gdscriptButton")]
 script = ExtResource("1")
 _spaceButton = NodePath("HBoxContainer/VBoxContainer/Space")
 _visualNovelButton = NodePath("HBoxContainer/VBoxContainer2/Visual Novel")
@@ -15,13 +15,13 @@ _roundedViewsButton = NodePath("HBoxContainer/VBoxContainer5/RoundedUI")
 _sqliteButton = NodePath("HBoxContainer/VBoxContainer6/SQLite")
 _gdscriptButton = NodePath("HBoxContainer/VBoxContainer7/GDScriptIntegration")
 
-[node name="ColorRect" type="ColorRect" parent="."]
+[node name="ColorRect" type="ColorRect" parent="." unique_id=1478326336]
 anchors_preset = 15
 anchor_right = 1.0
 anchor_bottom = 1.0
 color = Color(0.0431373, 0.0901961, 0.0470588, 1)
 
-[node name="Title" type="RichTextLabel" parent="."]
+[node name="Title" type="RichTextLabel" parent="." unique_id=193252348]
 clip_contents = false
 anchors_preset = 5
 anchor_left = 0.5
@@ -37,7 +37,7 @@ theme_override_font_sizes/normal_font_size = 48
 bbcode_enabled = true
 text = "[u]YarnSpinner Samples[/u]"
 
-[node name="PluginVersionLabel" type="RichTextLabel" parent="."]
+[node name="PluginVersionLabel" type="RichTextLabel" parent="." unique_id=2132340201]
 clip_contents = false
 anchors_preset = 5
 anchor_left = 0.5
@@ -53,7 +53,7 @@ theme_override_font_sizes/normal_font_size = 28
 bbcode_enabled = true
 text = "Plugin Version"
 
-[node name="PluginVersionValue" type="RichTextLabel" parent="."]
+[node name="PluginVersionValue" type="RichTextLabel" parent="." unique_id=1112540167]
 clip_contents = false
 anchors_preset = 5
 anchor_left = 0.5
@@ -67,18 +67,18 @@ size_flags_horizontal = 3
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
 bbcode_enabled = true
-text = "0.3.11"
+text = "0.3.20"
 script = ExtResource("2_shsu2")
 
-[node name="Logo" type="TextureRect" parent="."]
+[node name="Logo" type="TextureRect" parent="." unique_id=1051631919]
 offset_left = 76.0
 offset_top = 55.0
 offset_right = 314.0
 offset_bottom = 269.0
 texture = ExtResource("3_bcudv")
 expand_mode = 1
 
-[node name="HBoxContainer" type="HBoxContainer" parent="."]
+[node name="HBoxContainer" type="HBoxContainer" parent="." unique_id=1279368332]
 anchors_preset = 8
 anchor_left = 0.5
 anchor_top = 0.5
@@ -93,11 +93,11 @@ grow_vertical = 2
 size_flags_vertical = 8
 alignment = 1
 
-[node name="VBoxContainer" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer" type="VBoxContainer" parent="HBoxContainer" unique_id=731109250]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="Space" type="Button" parent="HBoxContainer/VBoxContainer"]
+[node name="Space" type="Button" parent="HBoxContainer/VBoxContainer" unique_id=888743355]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -106,7 +106,7 @@ theme_override_constants/outline_size = 5
 theme_override_font_sizes/font_size = 27
 text = "Space"
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer" unique_id=1785441193]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
@@ -118,11 +118,11 @@ Node Groups
 Shadow lines"
 scroll_active = false
 
-[node name="VBoxContainer2" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer2" type="VBoxContainer" parent="HBoxContainer" unique_id=1923299801]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="Visual Novel" type="Button" parent="HBoxContainer/VBoxContainer2"]
+[node name="Visual Novel" type="Button" parent="HBoxContainer/VBoxContainer2" unique_id=1218198861]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -132,7 +132,7 @@ theme_override_font_sizes/font_size = 27
 text = "Visual
  Novel"
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer2"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer2" unique_id=1497739487]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
@@ -142,11 +142,11 @@ Effect/ Animation Commands
 "
 scroll_active = false
 
-[node name="VBoxContainer3" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer3" type="VBoxContainer" parent="HBoxContainer" unique_id=1934888055]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="MarkupPalette" type="Button" parent="HBoxContainer/VBoxContainer3"]
+[node name="MarkupPalette" type="Button" parent="HBoxContainer/VBoxContainer3" unique_id=303366632]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -155,7 +155,7 @@ theme_override_constants/outline_size = 5
 theme_override_font_sizes/font_size = 27
 text = "Markup "
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer3"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer3" unique_id=1189343168]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
@@ -167,11 +167,11 @@ text = "* Action markup
 "
 scroll_active = false
 
-[node name="VBoxContainer4" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer4" type="VBoxContainer" parent="HBoxContainer" unique_id=1573324798]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="PausingTypewriter" type="Button" parent="HBoxContainer/VBoxContainer4"]
+[node name="PausingTypewriter" type="Button" parent="HBoxContainer/VBoxContainer4" unique_id=445553658]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -181,19 +181,19 @@ theme_override_font_sizes/font_size = 27
 text = "Pausing
 Typewriter"
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer4"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer4" unique_id=1885744326]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
 bbcode_enabled = true
 text = "Pausing at specific points while revealing your dialogue text"
 scroll_active = false
 
-[node name="VBoxContainer5" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer5" type="VBoxContainer" parent="HBoxContainer" unique_id=696498125]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="RoundedUI" type="Button" parent="HBoxContainer/VBoxContainer5"]
+[node name="RoundedUI" type="Button" parent="HBoxContainer/VBoxContainer5" unique_id=2083224762]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -202,19 +202,19 @@ theme_override_constants/outline_size = 5
 theme_override_font_sizes/font_size = 27
 text = "Rounded UI"
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer5"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer5" unique_id=942446904]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
 bbcode_enabled = true
 text = "Alternate dialogue UI style"
 scroll_active = false
 
-[node name="VBoxContainer6" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer6" type="VBoxContainer" parent="HBoxContainer" unique_id=829188392]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="SQLite" type="Button" parent="HBoxContainer/VBoxContainer6"]
+[node name="SQLite" type="Button" parent="HBoxContainer/VBoxContainer6" unique_id=87729081]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -225,19 +225,19 @@ text = "SQLite
 Variable
 Storage"
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer6"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer6" unique_id=158977072]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28
 bbcode_enabled = true
 text = "Custom variable storage script storing variables in a SQLite database"
 scroll_active = false
 
-[node name="VBoxContainer7" type="VBoxContainer" parent="HBoxContainer"]
+[node name="VBoxContainer7" type="VBoxContainer" parent="HBoxContainer" unique_id=324955247]
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="GDScriptIntegration" type="Button" parent="HBoxContainer/VBoxContainer7"]
+[node name="GDScriptIntegration" type="Button" parent="HBoxContainer/VBoxContainer7" unique_id=257084300]
 custom_minimum_size = Vector2(180, 100)
 layout_mode = 2
 theme = ExtResource("2")
@@ -246,7 +246,7 @@ theme_override_constants/outline_size = 5
 theme_override_font_sizes/font_size = 27
 text = "GDScript"
 
-[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer7"]
+[node name="features" type="RichTextLabel" parent="HBoxContainer/VBoxContainer7" unique_id=116614317]
 layout_mode = 2
 size_flags_vertical = 3
 theme_override_font_sizes/normal_font_size = 28

Samples/SampleEntryPoint.tscn

@@ -1,6 +1,6 @@
 using YarnSpinnerGodot;
 
-[System.CodeDom.Compiler.GeneratedCode("YarnSpinner", "0.3.0")]
+[System.CodeDom.Compiler.GeneratedCode("YarnSpinner", "0.3.20")]
 public partial class SpaceYarnVariables : YarnSpinnerGodot.InMemoryVariableStorage, YarnSpinnerGodot.IGeneratedVariableStorage {
     // Accessor for Number $times_talked_sally_before_ship
     public float TimesTalkedSallyBeforeShip {

Samples/Space/Dialogue/SpaceYarnVariables.cs

@@ -17,11 +17,6 @@ public override void _Ready()
         _instance = this;
         dialogueRunner.onDialogueComplete += OnDialogueComplete;
     }
-
-    public static void Test(global::YarnSpinnerGodot.IActionRegistration target)
-    {
-        target.AddCommandHandler<string, string>("test", SetSprite);
-    }
 
     [YarnCommand("setsprite")]
     public static void SetSprite(string character, string spriteName)