Skip to content

Commit

Permalink
update CHANGELOG.md for 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dogboydog committed Dec 14, 2024
1 parent 4cb2f0c commit 7e6c50a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
13 changes: 8 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [0.3.0] Pending

* Updated YarnSpinner DLLs to support version 3 of the Yarn Language, which supports many new features, described here:
* https://www.yarnspinner.dev/blog/yarn-spinner-30-what-to-expect
* Updated YarnSpinner DLLs to support version 3 of the Yarn Language, which supports many new features, similar to the feature set described for the Unity plugin here:
* https://www.yarnspinner.dev/blog/yarn-spinner-3-beta-1
* The samples have been updated to demonstrate these features, including enums, node groups, line groups, smart variables, shadow lines, generated variable storage code, `<<detour>>` and `<<once>>`.
* `[YarnCommand`] and `[YarnFunction]` have been updated to generate a class called `YarnSpinnerGodot.Generated.ActionRegistration`. This class will register all of your commands and functions without relying on reflection, which was the cause of some performance hiccups when starting a scene with a DialogueRunner in v0.2.* of the plugin
* To enable new features for an existing .yarnproject, edit the .yarnproject file to change the projectFileVersion to 3.
* If you keep your .yarnproject at projectFileVersion 2, you will have to re-compile the scripts in your yarn project to work with this version of the plugin.
* Update views to be async Task based, like the Unity plugin version 3.
* The existing `DialogueViewBase` interface is deprecated in favor of `AsyncDialogueViewBased`. Updated example views are provided.
* GDScript nodes that have methods that are the `snake_case` version of methods on `AsyncDialogueViewBase` can be added directly in `YarnProject.dialogueViews`
without requiring GDScriptViewAdapter. Supported methods: `on_dialogue_start_async() -> void`, `on_dialogue_complete_async() -> void`, `run_line_async(line: Dictionary) -> void`, `run_options_async(options: Array, on_option_selected: Callable) -> void`. You can use `await` statements in your GDScript view methods.
without requiring GDScriptViewAdapter. Supported methods: `on_dialogue_start_async() -> void`, `on_dialogue_complete_async() -> void`, `run_line_async(line: Dictionary) -> void`, `run_options_async(options: Array, on_option_selected: Callable) -> void`. You can still use `await` statements in your GDScript view methods. `AddCommandHandlerCallable` on `DialogueRunner` has been re-tested to ensure that commands can still be registered from GDScript. Also, the GDScriptIntegration sample has been updated with these changes.
* ⚠ Breaking change: LineProviderBehaviour has changed to require different methods and fields. If you have a custom line provider, please see the updated TextLineProvider as an * example of how to implement the updated class. Also notice that you must now set the yarn project on `TextLineProvider` instances, either via script or in the inspector.
* ⚠ Breaking change: Use DialogueRunner.VariableStorage, not DialogueRunner.variableStorage, nor DialogueRunner.SetDialogueViews (removed) to get/set the variable storage associated with a DialogueRunner. Previously there were two properties with different case that were both publicly accessible.
* ⚠ Breaking change: MarkupPalette renamed ColourMarkers to FormatMarkers, supporting new functionality like bold, underline, italics, as a way to demonstrate the updated formatting
* ⚠ Breaking change: the field DialogueRunner.verboseLogging has been removed.
* New functionality on YarnProject - optionally generate a C# variable storage class which has getters and setters for each variable declared in your yarn scripts. You can control the class that the generated file inherits from, the namespace it will be in, and the name of the class and file.

* TODO: More...


## [0.2.14] 2024-11-02
Expand Down Expand Up @@ -47,7 +50,7 @@ without requiring GDScriptViewAdapter. Supported methods: `on_dialogue_start_asy
## [0.2.9] 2024-06-30

* Set LineView's MouseFilter to 'ignore' to avoid interfering with clicks.
* Fix an issue where 'use fade effect' would cause the ConvertBBCodeToHTML feature to stop working while the text was fading out.
* Fix an issue where 'use fade effect' would cause the ConvertHTMLToBBCode feature to stop working while the text was fading out.
* Set the LineView to Visible=False when marking its alpha as 0.

## [0.2.8] 2024-05-24
Expand Down
2 changes: 1 addition & 1 deletion addons/YarnSpinner-Godot/Runtime/DialogueRunner.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Yarn Spinner is licensed to you under the terms found in the file LICENSE.md.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Godot;
using Godot.Collections;
using Yarn;
using ArgumentOutOfRangeException = System.ArgumentOutOfRangeException;

#nullable enable

Expand Down

0 comments on commit 7e6c50a

Please sign in to comment.