Soullies/Cielonos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
8186f54e90bf9fa108778997be2ffa0d3e63a4fc
Cielonos/Packages/dev.yarnspinner.unity/CHANGELOG.md
SoulliesOfficial 8186f54e90 新场景，剧情
2026-06-02 12:55:39 -04:00

1258 lines
87 KiB
Markdown
Raw Blame History

# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## [Unreleased]
### Added
### Changed
### Removed
## [3.2.1] 2026-03-27
### Changed
- Fixed an issue in Unity 6.4 where newly created Yarn scripts could fail to import correctly.
## [3.2.0] 2026-03-27
### Added
- When using the Unity Localization package Yarn Spinner can now sort the localisation tables based on a lines position in the file.
- This resolves an issue where lines added into the middle of a Yarn file. However, this does require sorting your localisation table every time you edit your Yarn files.
- This setting defaults to off, and can be enabled in Yarn Spinners settings in `Edit -> Project Settings -> Yarn Spinner`.
- When sorting, any values found in the localisation table that didn't come from your Yarn files will be logged, and sorted to the top of the table.
- `YarnSpinnerAssemblyGeneratedYSLSPath` function to the `YarnSpinnerProjectSettings` so that each assembly can have a generated and consistent path.
- Generated YSLS files now include subtype information for instance commands.
- This means a command like `<<move gary left>>` now knows that the `"gary"` is the name of a game object, and the specific game object subclass.
- This only works at a single level of MonoBehaviour depth; subclasses of a `MonoBehaviour` subclass will not be recognised.
- `YarnNodeParameterAttribute` can now be added to string parameters in function and command methods
- This is intended to allow you to hint to the VSCode extension that, when writing this parameter in commands and functions, it should limit suggestions to nodes.
- `YarnEnumParameterAttribute` can now be added to parameters in functions and command methods.
- This has one field, which is the name the enum as declared in your Yarn.
- This is intended to allow you to hint to the VSCode extension to offer enum based suggestions. This is a temporary solution, until forward declaration of Yarn enums into C# works.
- Incorrectly defined parameters for commands and functions will now generate diagnostics on the C# implementation, warnings exist for:
- invalid types
- incorrectly attributed parameters
- `ContentDidDismiss` call to the `IAsyncTypewriter` to let typewriters know they are safe to do any cleanup
- A `TMP_Text` property called `TextElement` to the `IAsyncTypewriter`
- this is optional but most of the time custom typewriters will need to get the main text element anyway so might as well just have it as something they are given at the start
### Changed
- `YarnProjectImporter` now updates asset addresses and generates the C# variable storage class _after_ the project import completes, rather than during the import.
- Each assembly now gets its own YSLS file when generating them.
- We renamed the test `.asmdef` files from `YarnSpinnerTests.x` to `YarnSpinner.Unity.Tests.X`, so that they are matched by the existing filters.
- Generated a YSLS file now matches the newer schema. See the [Yarn Spinner core repo](https://github.com/YarnSpinnerTool/YarnSpinner/blob/main/YarnSpinner.LanguageServer/src/Server/Documentation/ysls.schema.json) for details of this.
- When matching assets to line IDs, the importer now prefers exact matches to the line ID.
- `YarnProjectImporterEditor` now resets some internal state when creating its UI, which should help avoid a bug where the list of sources would grow over time.
- Added explicit registration for `UnityEngine.Awaitable`, and the missing cases for `System.Threading.Tasks.Task` commands, fixing issues where some times certain specific configurations would fail to register the command.
- As part of this, we also made it so Commands can now be registered with up to 16 parameters.
- Please don't actually register a command with 16 parameters.
- Fixed a bug where the InterfaceContainer would sometimes lose it's connection.
- unsure why this happens, just Unity things™
- Line Presenter now uses the `InterfaceContainer` for custom typewriters.
- `.ysls.json` file generation is now on by default.
- Yarn Spinner for Unity now works with `EntityId` objects instead of instance ID integers in Unity 6.4 and later.
## [3.1.4] 2025-12-19
### Changed
- Fixed an issue that caused build errors when using the Text Animator add-on.
## [3.1.3] 2025-12-09
### Changed
- Fixed an issue that caused OpenUPM downloads to fail to compile.
## [3.1.1] 2025-12-03
### Overview
Yarn Spinner for Unity 3.1 contains a number of improvements and useful changes.
#### Dialogue Runner Is Now More Async
The dialogue runner's `StartDialogue` and `Stop` methods are now `async`, and return a task. When you call `StartDialogue`, you'll receive a task (either a `System.Threading.Tasks` task, a `UnityEngine.Awaitable`, or a `UniTask`) that will complete after every dialogue presenter has finished running its `OnDialogueStartedAsync` method. Likewise, the `Stop` method will finish after every dialogue presenter has finished running its `OnDialogueCompleteAsync` method. This is really useful for making sure that you don't accidentally make a change to your scene in the middle of your dialogue presenters getting ready.
#### Dialogue Option Fallthrough
In Yarn Spinner, you can add a condition to the end of an option. If the condition evaluates to `false`, Yarn Spinner will mark the option as "unavailable". It's up to your game to decide what that means - you might want to make the option visible but unselectable, or you might want to hide the option from the player entirely. However, if _every_ option is unavailable, the player has no option they could select. Previously, this could cause your game to have to soft-lock the player, since they weren't able to proceed.
In Yarn Spinner 3.1, dialogue presenters are now allowed to tell the Dialogue Runner that no option was selected at all. When this happens, Yarn Spinner will skip the options and move on to the next part of the script:
```
Guard: Who goes there?
// If the player is a thief, a royal visitor, or a merchant, then
// go run the appropriate conversation for that. The player might be
// some combination of the three, so let them choose.
-> A thief! <<if $player_is_thief>>
<<jump Guard_Thief_Conversation>>
-> A royal visitor! <<if $player_is_royal_visitor>>
<<jump Guard_RoyalVisitor_Conversation>>
-> A merchant! <<if $player_is_merchant>>
<<jump Guard_Merchant_Conversation>>
// But if the player is NONE of those, then none of the options would have
// been available. We'll fall through to here.
Player: I'm nobody!
<<jump Guard_Nobody_Conversation>>
```
> [!NOTE]
> You can turn off this behaviour by setting the `allowOptionFallthrough` property on your `DialogueRunner` to `false`.
#### Lines Know Where They Came From
When Yarn Spinner sends a line to your game, it wraps up the line in an object called a [`LocalizedLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.localizedline). Previously, if your game has multiple Dialogue Runners that are running at the same time, it wasn't possible to know which runner the line came from. In Yarn Spinner 3.1, the `LocalizedLine` now has a [`Source`](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity/yarn.unity.localizedline/yarn.unity.localizedline.source) property that tells you where it came from.
#### Options Can Now Be Hurried Up And Cancelled
Just like how lines have a separate 'hurry up' and 'next' cancellation tokens that act as a signal to move things along, options now have the same 'hurry up' and 'next' tokens. (Previously, they only had a single cancellation token that signalled that option selection was no longer necessary.) This allows your game to signal that you want to hurry up the presentation of your dialogue's options.
#### New Typewriter System
We've updated the way that typewriters are used in the built-in Line Presenter system, to make it easier to customise. This is useful for when you want to take full control over how the line appears over time, and for when you want to have in-game events occur (like sound effects) as the line appears.
To create a custom typewriter, create a class that implements [`IAsyncTypewriter`](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity/yarn.unity.iasynctypewriter). You can find an example of how to write a custom typewriter in the source code for the [`LetterTypewriter`](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/blob/main/Runtime/Views/Typewriter/LetterTypewriter.cs) class.
> [!NOTE]
> As part of this change, the On Character Typed event on Line Presenter has been removed. If you want to run code every time a character appears, create a new script that subclasses from [ActionMarkupHandler](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity/yarn.unity.actionmarkuphandler), and add that to an object in your scene. Add that object to the Line Presenter's "Event Handlers" list. In your ActionMarkupHandler subclass, you can write code that gets called every time characters appear on screen by implementing the [OnCharacterWillAppear method](https://docs.yarnspinner.dev/3.1/api/csharp/yarn.unity/yarn.unity.actionmarkuphandler/yarn.unity.actionmarkuphandler.oncharacterwillappear).
#### Removed Legacy `DialogueView` Classes
Yarn Spinner 3.0 introduced a new programming model for presenting dialogue, called [Dialogue Presenters](https://docs.yarnspinner.dev/3.1/components/dialogue-view). As part of the rollout of this new API, we made the old `DialogueView` class act as a compatibility layer, and marked it as deprecated. Yarn Spinner 3.1 removes this deprecated code. If you have code that started life as a Yarn Spinner 2.0 project, you will need to [migrate your legacy dialogue presentation UI code to use Dialogue Presenters](https://docs.yarnspinner.dev/3.1/changelog/upgrading-from-yarn-spinner-2#dialogueviewbase-is-now-dialoguepresenter) by changing their parent class to `DialoguePresenter`, and implementing the new methods for presenting lines and options
### Added
- `DialogueRunner` will now log warnings if a dialogue presenter throws an `OperationCanceledException` - these usually indicate that a task they were themselves waiting on was cancelled, and that the presenter didn't clean up.
- The generated `.ysls.json` file now contains more complete command and function information.
- Added a new attribute for Yarn Spinner editors: `LabelFrom` allows specifying a dynamic label for a property by invoking a method.
- Added multiple typewriters and support for them on the `LinePresenter`:
- By Word
- By Letter
- Instantly
- Added a virtual `IAsyncTypewriter` field `Typewriter` onto `DialoguePresenterBase`
- Added new virtual `OnNodeEnter` and `OnNodeExit` calls onto `DialoguePresenterBase`.
- Added a static `FindRunner` call onto `DialogueRunner`, which first tries to find it on the game object itself, followed by anywhere in the scene.
- Added a `Source` field to the `LocalizedLine`, this can be of any type but by default will be the `DialogueRunner` that caused the line to be created
- Options can now be hurried up, the same as lines
- added `RunOptionsAsync(DialogueOption[], LineCancellationToken)` to `DialoguePresenterBase`.
- this method is virtual and is now the recommended way to respond to options
- the default implementation just returns nothing selected
- added `NextContentToken` to `LineCancellationToken` which mirrors the existing `NextLineToken`.
- added `IsNextContentRequested` to `LineCancellationToken` which mirrors the existing `IsNextLineRequested` bool.
- added `RequestHurryUpOption` to `DialogueRunner`.
- added hurry up option inputs to `LineAdvancer`
- `LineAdvancer` now better handles situations where you want to use the same input for hurrying up and skipping lines.
- This behaviour is controllable via the `separateHurryUpAndAdvanceControls` field
- Added a new container type `InterfaceContainer`, a wrapper class to clean up some interface serialisation pains
### Changed
- Fixed a compiler error that occurred when the Unity Input System was enabled, but not actually installed.
- Fixed an error where calls to `DialogueRunner.AddFunction()` in methods that are in nested classes would cause the function to be registered multiple times, leading to compiler failures.
- Fixed a bug where versions of Unity prior to Unity 2022.3.33 had compilation errors around packages.
- Fixed a bug where some inspector property fields weren't bound preventing configuring Unity localisation or addressables in Unity 2022.3.
- Added more specificity to the `Analyser` class's use of the C# code generation API.
- `AddLineTagsToFilesInYarnProject` is now `public`, allowing for easier use of it in editor scripting.
- Showing character name behaviour in the `LinePresenter` now correctly matches the documentation.
- `DialogueRunner.StartDialogue` is now asynchronous and waits for all presenters to finish their `OnDialogueStartedAsync` calls before exiting
- `DialogueRunner.Stop` is now asynchronous and waits for all presenters to finish their `OnDialogueCompleteAsync` calls before exiting
- Fixed a bug where the continue button on the `LinePresenter` could become non interactive.
- `PaletteMarkerProcessor` and `StyleMarkerProcessor` now look less aggressively for their Dialogue Runner.
- `LocalizedLine.TextWithoutCharacterName` still does not contain the text of the character, but does contain the Markup attribute of the character.
- This allows other parts of your dialogue UI that might need to know who said a line still use the `TextWithoutCharacterName` property.
- `ReplacementMarkuphandler` now returns a `ReplacementMarkerResult` instead of a list of diagnostics.
- This is to match the behaviour change in core to fix a markup offset bug
- `OptionsPresenter` now returns null if there are no options that can be selected due to their availability.
- If there are no available options, Dialogue Runner will now fallthrough to the next piece of content
- This behaviour can be disabled in the `allowOptionFallthrough` field on the runner.
- Fixed an issue where Builtin localisation would always use the base localisation when fetching a localised asset ([#344](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/issues/344))
- The UPM samples installer now installs from a specific tag, rather than the head of the repo.
- Options can now be hurried up, the same as lines. This necessitated several obsolences:
- `RunOptionsAsync(DialogueOption[], CancellationToken)` is now obsolete.
- `IsNextLineRequested` is now obsolete.
- `NextLineToken` is now obsolete.
- `RunOptionsAsync(DialogueOption[], CancellationToken)` is now virtual.
- the default implementation selects nothing and instantly returns.
- The Dialogue Presenter template file now has the newer form of `RunOptionsAsync`.
- Built in presenters now use the newer form of `RunOptionsAsync`.
- The `InputSystemAvailability` static class has been made public.
- `LineAdvancer` will now ignore the signal to 'hurry up' if it comes in the same frame as line was requested to be shown.
- This fixes a bug where the same key was used to start conversation as well hurry up dialogue.
- Fixed an issue on `EnsureInputModuleAvailable` where, if there was an input system in the scene but it was of the wrong type, the console would fill up with errors.
- `DialogueRunner` now waits one frame before starting dialogue when automatically start dialogue is turned on.
### Removed
- Removed `ActionMarkupHandlers` list from `DialoguePresenterBase`. This was only used by the default line presenter, and is now handled by the typewriter system. This which is more representative of what Action Markup Handling already entailed.
- Removed the legacy Dialogue Views, Typewriter, and Effects.
- Removed the `ReplacementMarkupHandler.NoDiagnostics` static property, as this no longer matches any need due to core changes around replacement markup.
- Removed `RunOptionsAsync(DialogueOption[], CancellationToken)` from `LinePresenter`. This method is now virtual, and the default implementation does what we needed here.
## [3.0.3] 2025-06-21
### Added
- Added a `[br /]` markup tag into the common markers default markup palette.
- This will be translated into a TextMeshPro `<br>` marker.
- Line Advancer will now fall back to using key codes if Input Actions are selected, but Unity Input System is not available.
- The Dialogue System prefab now creates a UI input module that matches your current input system when it's added to the scene, rather than baking in a specific input module.
### Changed
- Fixed a bug where `LinePresenter` would not run all registered action markup handlers during a typewriter effect.
- Fixed an issue where the default Dialogue Runner prefab didn't have its `LineAdvancer` component configured correctly.
- Renamed `actionMarkupHandlers` to be `eventHandlers` on the `LinePresenter`, this fixes an easy to occur typo with the base classes `ActionMarkupHandlers`.
- Fixed an issue where Line Advancers set to use Key Codes would not work when the Legacy Input Manager is not available.
## [3.0.2] 2025-06-13
### Added
- The inspector for the Dialogue Runner now has a drop down for selecting the saliency strategy.
- `VariableStorageBehaviour` now supports adding a variable change listener for _all_ variables.
### Changed
- The Yarn Spinner header in the Inspector no longer shows `<u></u>` markup in versions of Unity prior to Unity 6.
- `LinePresenter` now implements its typewriter effect with `BasicTypewriter`, an implementation of the `IAsyncTypewriter` interface.
- The typewriter effect in `LinePresenter` is now framerate-independent.
- Fixed an issue in UnityLocalisedLineProvider where an exception would be thrown if an asset table was not provided.
### Removed
- `SerializableDictionary<TKey,TValue>` no longer exposes non-generic `IDictionary` methods; instead, all operations are now correctly type-checked.
## [3.0.0] 2025-05-16
### Added
- A basic saliency sample to show off the basics and how to get started with storylets.
- Logo and docs/help links to custom editors in Yarn Project (standalone), Yarn Script (standalone), and Dialogue Runner (component when on GameObject).
- Description of package samples which summarises Samples therein.
- Updated a few out-of-date HelpUrl values which referenced v1 docs.
- Default Yarn Project exlude patterns updated to ignore the standard samples folders
- Functions that are registered using the `AddFunction` method are now supported by the Yarn Spinner compiler.
- YarnPackageImporter now has an install samples menu item in `Window -> Yarn Spinner -> Install Samples`
- 'Incorrect number of parameters' error messages when running commands will now show more detailed error messages if available.
- Yarn scripts can now directly link to vscode for situations where you want to use that as your Yarn editor but have another editor as your C# editor.
- `UnityLocalisedLineProvider` now supports [fallback locales](https://docs.unity3d.com/Packages/com.unity.localization@1.5/manual/Locale.html#fallbacks).
- `UnityLocalisedLineProvider` now supports shadow lines.
- `BuiltinLocalisedLineProvider` now supports falling back to different locale.
- `DialogueRunner.DialogueTask` now completes after all dialogue presenters finish their `OnDialogueComplete` method call, rather than before.
- The `DialogueRunner.onDialogueComplete` event is now invoked after all dialogue presenters finish their `OnDialogueComplete` method call, rather than before.
### Changed
- Fixed an error that caused the YarnProject asset editor to incorrectly report a compile error when there wasn't one.
- Certain errors thrown when a command can't be run now show the full text of the command, not just the command name.
- The default Yarn Spinner Script template is now no longer an empty node.
- Renamed 'Dialogue View Script' menu item to 'Dialogue Presenter Script'.
- Added `DialogueRunner.DialoguePresenters` (and marked `DialogueRunner.DialogueViews` as obsolete.)
- Fixed a lot of missing null checks
- Fixed a bug in SampleRenderDetector that caused build errors.
- Menu for creating a prefab dialogue system now says "Dialogue System" instead of "Dialogue Runner"
- Line Advancer will now advance to the next line if the line presenter is finished presentation and is awaiting input and the player sends the hurry up action
- this only happens when the default line presenter is the one presenting the line
- other presenters don't really have an obvious "I am done showing, but not done presenting" concept as the line presenter does
- adopting this behaviour into other presenters is not difficult, just not something that can be done automatically
### Removed
- SaveStateToPlayerPrefs method
- LoadStateFromPlayerPrefs method
- `LinesAvailable` property from line providers, it no longer makes sense in an async world
- `baseLayer` property on Simple Character as it was no longer used
- Obsolete uxml elements on `LanguagePopup.cs`
- All samples, they now live in their own repository
## [3.0.0-beta2] 2025-04-09
### Added
- Yarn action handling now supports a wider range of return values.
- `YarnImporter.GetHashString()` is now public.
- `UnityLocalisedLineProvider` no longer throws an exception if an asset table is provided but does not contain an asset for a line.
- `DialogueRunner.CommandDispatcher` is now set up on first access, rather than in `Awake`.
- This allows other objects to work with the command dispatcher (for example, registering new methods) in their `Awake` methods, even if their `Awake` methods run before `DialogueRunner`'s.
- `YarnCommand` and `YarnFunction` commands now allow including `.` characters in their names.
- Fixed an issue in SerializableDictionary.cs that caused builds to fail.
- `DialogueRunner.AddCommandHandler` and `DialogueRunner.AddFunction` now validate that the provided names contain no spaces.
- `DialogueRunner.AddCommandHandler` now supports methods whose last parameter is an array of values.
- This allows for commands with a variable list of parameters. For example, consider the following method:
```csharp
void LogStrings(int a, string[] remainder) {
Debug.Log($"a = {a}, remainder={string.Join(",", remainder)}");
}
```
This method can be registered as a Yarn command:
```csharp
dialogueRunner.AddCommandHandler<int, string[]>("my_command", LogStrings);
```
And called from Yarn Spinner:
```
// logs "a = 42, remainder=this,is,pretty,great"
<<my_command 42 this is pretty great>>
```
> [!NOTE]
> Array parameters are required to be the last parameter of the method.
- Variable storage objects now allow registering a 'change listener' that runs when a variable is changed.
- To add a change listener, call `AddChangeListener` on your variable storage, and provide the name of the variable you want to watch for changes for and a delegate that should run when the variable changes:
```csharp
VariableStorageBehaviour storage = // ...
var changeListener = storage.AddChangeListener<bool>("$myVariable", (newValue) => {
Debug.Log("$myVariable changed to " + newValue);
});
```
You can remove a change listener by disposing it:
```csharp
changeListener.Dispose();
```
Change listeners can't be added for smart variables. If you add a change listener for a stored variable (that is, one declared in the Yarn script), the change listener's parameters must match the type of the stored variable.
> [!NOTE]
> If you're implementing your own subclass of `VariableStorageBehaviour`, your `SetValue` methods must call `NotifyVariableChanged` to notify any registered change listeners.
> ```csharp
> public override void SetValue(string variableName, string newValue)
> {
> // ... existing behaviour ...
>
> NotifyVariableChanged(variableName, newValue);
> }
> ```
- Added a sample (CustomSaliency) showing off making a custom saliency selection strategy.
- Added a sample (InlineEvents) showing off using `ActionMarkupHandler`'s to perform in line events.
- Added a sample (Replacement Markers) showing off various different approaches to performing marker replacement.
- The Dialogue System prefab now has support for some common rich text tags
- `[i]` will italicise text
- `[b]` will embolden text
- `[u]` will underline text
- `[s]` will strike through text
- `AsyncOptionsView` now supports configuring its fade duration.
- `MarkupPalette` and the associated `PaletteMarkerProcessor` now support custom TMP rich text tags beyond what the more basic markers allow.
- `LineMetadata` now has public API methods for constructing and manually adding elements.
- `DialogueRunner.SetProject` now sets the `Program` of its internal `Dialogue` object. Previously, this didn't happen until `StartDialogue()`.
- Added a sample (Advanced Saliency) making use of templated nodes and built in saliency to show off creating storylet vignettes.
- `IActionMarkupHandler` interface which the `ActionMarkupHandler` monobehaviour now conforms to
- Action markup handlers now has a `OnLineWillDismiss` method which is called right before the line view fades itself away.
- `LinePresenterButtonHandler` is a new `ActionMarkupHandler` subclass that manages the continue button on the line view.
### Changed
- Fixed an issue where, on Windows, projects would fail to automatically update when a file that belonged to them was created or edited.
- Fixed an issue where Unity Localization `rid` values would change on reimport when they didn't have to.
- Fixed an issue where a `[pause/]` marker at the start of the line would cause all pauses to not work ([@iatenothingbutriceforthreedays](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/pull/291))
- Inspector-exposed fields on `LineView` are now public.
- Fixed an issue where a `.meta` file was causing warnings to appear in Unity on import. ([@Colbydude](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/pull/294))
- Fixed an issue where functions would not be registered with the VM until after the first call to `CommandDispatcher`.
- `YarnProjectImporter.GenerateStringsTable` is now public.
- Yarn Projects now allow choosing more specific cultures (for example 'pt-BR' and 'en-AU' rather than simply 'pt' and 'en') as their base language.
- `DialogueRunner.dialogueCompleteTask` now uses a completion source, rather than polling.
- `YarnNode` dropdowns no longer show individual node group members in the list.
- `IActionRegistration` now correctly supports commands without parameters.
- Renamed `TemporalMarkupProcessor` to `ActionMarkupHandler`.
- Renamed `AttributeMarkerProcessor` to `ReplacementMarkupHandler`
- When using Unity Localization, Yarn Projects now populate the string table collection using a post-processor, rather that in the middle of import. This should fix errors that would occasionally cause string tables to not correctly update when a Yarn file changes.
- Fixed an issue where the System.Threading.Tasks implementation of YarnTask.WaitUntil did not return early when the CancellationToken was cancelled ([@dogboydog](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/pull/304))
- If a `VoiceOverView` is configured to automatically advance at the end of audio playback, when a line that has no `AudioClip` is delivered, the `VoiceOverView` will now advance the line immediately after logging an error.
- Renamed `FormatForMarker` to `PaletteForMarker` in `MarkupPalette`.
- Generated variable storage code now represents string values as signed integers, not unsigned integers. (Unity doesn't correctly serialize enum values over the signed integer maximum.)
- `YarnNode`-attributed variables can now be configured to allow editing as a text field even when the Yarn Project is not set. This is now the default behaviour for `DialogueReference`.
- `sourceFilePaths` on `ProjectImportData` renamed to be `sourceFilePatterns` because that is what it actually is.
- Fixed a crash in project import when externally declared invalid functions had no associated file with the error
- When an error that `YarnProjectImportEditor` needs to show has no file associated with it the editor no longer draws an empty TextAsset field.
- Heavily reworked the structure of the project folders.
- Renamed `AsyncDialogueViewBase` to be `DialoguePresenter`
- Renamed `AsyncLineView` to be `LinePresenter`
- Renamed `AsyncOptionItem` to be `OptionItem`
- Renamed `AsyncOptionsView` to be `OptionsPresenter`
- Renamed `VoiceOverView` to be `VoiceOverPresenter`
- `LanguageAttribute` and `YarnNodeAttribute` are now in the `Yarn.Unity.Attributes` namespace.
- Facial expressions on the NPCs now have more common names.
- `MoveEvent.cs` now uses YarnTasks instead of `Awaitable`
- `ActionMarkupHandler` now conforms to the `IActionMarkupHandler` interface
- `LinePresenter` now has a public list of `IActionMarkupHandler` for non-monobehaviour based markup handling.
- `PauseEventProcessor` is now just an `IActionMarkupHandler` and no longer a monobehaviour.
- Fixed a bug that could cause multiple option items to be selected at once.
- The awaitable version of `YarnTask.Delay` no longer throws an `OperationCancelledException` when cancelled.
### Removed
- `YarnProject.GetHeaders` is now deprecated, in favour of `DialogueRunner.Dialogue.GetHeaders`.
- Removed `TypewriterHandler`; this behaviour is now intrinsic to the `AsyncLineView`.
- Removed the `tags` header from the template new yarn file as it is no longer the best way to add metadata headers into a node.
- Removed Continue Button support from the `LinePresenter`
## [3.0.0-beta1] 2024-11-30
### Added
- Updated voiceover and translation credits for the Intro sample scene.
- Added shadow line support to BuiltInLineProvider.
- Added support for generating C# variable storage classes that expose properties for string, number and boolean variables found in a Yarn Project.
- `YarnCommand` methods may now use `params` array parameters.
- Asynchronous Default View and Prefab:
- `AsyncLineView` is intended as a full replacement for `LineView`.
- `AsyncOptionsView` is intended as a full replacement for `OptionsListView`.
- `AsyncOptionItem` is intended as a full replacement for `OptionView`.
- `LineAdvancer` is a replacement for `DialogueAdvanceInput`.
- `Async Dialogue System` prefab is intended as a full replacement for `Dialogue System` prefab.
- New approach to handling replacement markup:
- `AttributeMarkerProcessor` defines the required fields and methods to create replacement markup processors.
- `PaletteMarkerProcessor` implements `MarkupPalletes` replacement.
- `StyleMarkerProcessor` implements TMP style tag replacement.
- New approach to handling display-time markup:
- `TemporalMarkupHandler` defines the required fields and methods to create markup handlers.
- Typewriter is now implemented as a markup handler inside `TypewriterHandler`.
- `LineCancellationToken` is a combination of two cancellation tokens
- this allows for the highly common model of asking a line to hurry up vs skip
- New method `HurryUpCurrentLine` on `DialogueRunner` is how to trigger this.
- Async form of `FadeAlpha` added to `Effects`.
- Cancellable `Delay` added to `AsyncHelpers`.
- Cancellable `WaitUntil` that uses a predicate added to `AsyncHelpers`.
- Localization assets can now be created as external assets, and provided to the Yarn Project importer.
- This can be useful if you need to edit the contents of your Localization assets, rather than letting Yarn Spinner create and manage them for you.
- You can now create a new Dialogue View script by opening Assets -> Create -> Yarn Spinner -> Dialogue View Script. This will create a new C# file that contains an empty template for building your own Dialogue View.
### Changed
- Line Providers are now responsible for performing markup parsing
- for the most part this will done by calling `Yarn.Markup.LineParser.ExpandSubstitutions`.
- Built in and Unity Loc line providers now handle this for you.
- `MarkupPallete` now supports more than just colour.
- Dialogue Runner's "Start Automatically" option now defaults to off, not on.
- Dialogue Runner's "On Command" event has been renamed to "On Unhandled Command", to better reflect when it's called.
- `DialogueViewBase` is now deprecated. New Dialogue Views should subclass `AsyncDialogueView`.
- The `DialogueViewBase` class now acts as a compatibility layer for the new
async dialogue view system, and should not be used in new code.
- If a Line Provider fails to return a valid line, the Dialogue Runner will send the Dialogue Views an 'Invalid Line' line, rather than skipping over it completely.
- `InMemoryVariableStorage`'s `debugTextView` property is now a TextMeshPro text field, rather than a legacy Text field.
### Removed
- Remove certain items that were previously marked as obsolete:
- Obsolete method `DialogueRunner.ResetDialogue`
- Obsolete property `YarnFunctionAttribute.FunctionName`
- Obsolete property `YarnCommandAttribute.CommandString`
- Obsolete method `YarnProject.GetProgram`
- `ViewBehaviour` enum inside of `AsyncDialogueViewBase`.
## [2.5.1] 2024-12-17
No changes between this version and v2.5.0; this release fixes an issue related to deployment on OpenUPM.
## [2.5.0] 2024-12-16
### Added
- `DialogueRunner.AddCommandHandler` and `DialogueRunner.AddFunction` now validate that the provided names contain no spaces.
- `DialogueRunner.AddCommandHandler` now supports methods whose last parameter is an array of strings.
- This allows for commands with a variable list of parameters. For example, consider the following method:
```csharp
void LogStrings(int a, string[] remainder) {
Debug.Log($"a = {a}, remainder={string.Join(",", remainder)}");
}
```
This method can be registered as a Yarn command:
```csharp
dialogueRunner.AddCommandHandler<int, string[]>("my_command", LogStrings);
```
And called from Yarn Spinner:
```
// logs "a = 42, remainder=this,is,pretty,great"
<<my_command 42 this is pretty great>>
```
> [!NOTE]
> Array parameters are required to be string arrays, and are required to be the last parameter of the method.
- Language popups now allow choosing a custom language code.
- Yarn Spinner's XML documentation is now included in the distribution.
### Changed
- Fixed an issue where, on Windows, projects would fail to automatically update when a file that belonged to them was created or edited.
- Fixed an issue where Unity Localization `rid` values would change on reimport when they didn't have to.
- Fixed an issue where a `[pause/]` marker at the start of the line would cause all pauses to not work ([@iatenothingbutriceforthreedays](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/pull/291))
- Inspector-exposed fields on `LineView` are now public.
- Fixed an issue where a `.meta` file was causing warnings to appear in Unity on import. ([@Colbydude](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/pull/294))
- `YarnProjectImporter.GenerateStringsTable` is now public.
- Yarn Projects now allow choosing more specific cultures (for example 'pt-BR' and 'en-AU' rather than simply 'pt' and 'en') as their base language.
- Fixed a issue where `AudioLineProvider` would throw an exception if an asset was already loaded and was requested a second time.
## [2.4.2] 2024-02-24
### Added
- Added a Unity Project scoped settings that allows you to override some of the default behaviours of Yarn Spinner.
- Yarn Spinner settings are saved to the path `ProjectSettings\Packages\dev.yarnspinner\YarnSpinnerProjectSettings.json`.
- The settings be changed in the Project Settings window, by choosing `Edit -> Project Settings -> Yarn Spinner`.
- The setting currently supports three convenience features of Yarn Spinner:
- Automatically associating assets with localisations
- Automatically linking `YarnCommand` and `YarnFunction` attributed methods to the Dialogue Runner.
- Generating a `.ysls.json` file that stores information about your Yarn attributed methods.
- This file is saved to `ProjectSettings\Packages\dev.yarnspinner\generated.ysls.json`.
- This is an experimental feature to support better editor integration down the line. As such, this feature defaults to 'off'.
- Enabling or disabling `YarnCommand` and `YarnFunction` linking, or `.ysls` generation, will cause your project to recompile.
- Enabling or disabling asset linking will cause a reimport of all `yarnproject` assets.
- `Yarn.Unity.ActionAnalyser.Action` now has a `MethodIdentifierName` property, which is the short form of the method name.
- `DialogueAdvanceInput` now supports Virtual Button names in addition to KeyCodes and Input Actions.
- This can be configured to work on button or key release or press. By default, the component works on release.
- `LineView` now will add in line breaks when it encounters a self closing `[br /]` marker.
- Yarn attributed Functions and Commands can now use constant values in addition to literals for their name.
### Changed
- Update the minimum Unity version to 2021.3.
- Fixed a bug where line pauses could sometimes not happen when the user's framerate is low.
- Fixed a bug where the Rounded Views sample wouldn't import correctly.
- Fixed Minimal Dialogue Runner sample that was using obsolete methods.
- Fixed a bug where TMPShim wasn't being detected.
- Standard library functions (like `random`, `dice`, `round_places`, etc) have been moved to the core Yarn Spinner library.
- Fixed a bug where the audio assets in the samples weren't being linked correctly resulting in playback errors.
- Intro Sample: Moved the Character Color view to a new stand-alone object (it's easier to explain how to do this in a tutorial!)
- `Analyser` no longer ignores non-public methods.
- This is now handled during codegen side so we can better log it.
- `ActionsGenerator` will now generate C# warnings for non-private methods that are attributed as `YarnFunction` or `YarnCommand`.
- `ActionsGenerator` still logs to a temporary location, but now into a `dev.yarnspinner.logs` folder inside the temporary location.
- Auto-advancing `LineView`s will no longer attempt to advance dialogue that has been stopped.
- Actions Registration now dumps generated code into the same temporary folder the logs live in
- `ActionsGenerator` will now generate C# warnings for incorrectly named methods that are attributed as `YarnFunction` or `YarnCommand`.
- Fixed a bug where `AudioLineProvider` didn't allow runtime changing of the text locale.
- Fixed a bug where the Unity Localisation strings tables would have duplicate lines after tagging all lines in a project.
### Removed
- Remove certain items that were previously marked as obsolete:
- Obsolete method `DialogueRunner.ResetDialogue`
- Obsolete property `YarnFunctionAttribute.FunctionName`
- Obsolete property `YarnCommandAttribute.CommandString`
- Obsolete method `YarnProject.GetProgram`
- Removed `YarnParameterAttribute` and `YarnStateInjectorAttribute`.
- These attributes were formerly used in earlier versions of Yarn Spinner's
action system, but are no longer used.
## [2.4.1] 2024-01-30
- Version 2.4.1 is the first release of the paid version of Yarn Spinner on the [Unity Asset Store](https://assetstore.unity.com/packages/tools/behavior-ai/yarn-spinner-for-unity-267061) and on [itch.io](https://yarnspinner.itch.io). It's identical to v2.4.0.
- Yarn Spinner is and will remain free and open source - we also make it available for purchase as an excellent way to support the team.
- While you're reading, why not consider our [paid add-ons](https://yarnspinner.itch.io), which add some fantastic and easy-to-customise dialogue views?
## [2.4.0] 2023-11-15
### Added
#### In-Line Pause Support
- The built-in Line View now can now identify markup based pauses and insert pauses into the typewriter effect.
- To use this you can use the `pause` markup inside your lines:
```
Alice: wow this line now has a halt [pause=500 /] inside of it
```
- This line will stop the typewriter for 500ms after the `halt` is shown. After the 500ms delay, the rest of the line will appear.
- Two new Unity events have also been added to be informed when pauses happen:
- `onPauseStarted`
- `onPauseEnded`
- Added a new `PausableTypewriter` effect that works identically to the existing `Typewriter` effect, but supports arbitrary pauses. This effect can be used in your own custom line views to add support for the `[pause/]` markup.
- To learn more about how the pause system works, take a look at the `PausableTypewriter.GetPauseDurationsInsideLine` method!
#### New Samples
- Several new sample projects have been added:
- **Shot Reverse Shot** shows how you can use Cinemachine virtual cameras and custom dialogue views to make a shot-reverse-shot scene in your game.
- **Sliced Views** shows off a new alternative default line and option view prefab.
- **Markup Palette** demonstrates the new `MarkupPalette` system.
- **User Input and Yarn** shows how you can use blocking commands and TMP Input fields to get input into Yarn variables.
- **Pausing the Typewriter** howing how you can use the `[pause/]` marker to temporarily pause in the middle of a line.
#### New Saving Features
- Added two new basic save methods on `DialogueRunner` that use the persistent data storage location as their save location:
- `SaveStateToPersistentStorage` saves all variables known to the Dialogue Runner to a named file in the [Application.persistentDataPath](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html) folder.
- These methods, `SaveStateToPersistentStorage` and `LoadStateFromPersistentStorage` are intended to replace the older `PlayerPref` based system for basic saves.
- Note: For more complex games, we are still assuming you will need to craft your own bespoke save system.
#### Markup Palette System
- The Line View and Options List View prefabs now support _markup palettes_, which allow you to customise the colours of your lines and options using Yarn Spinner's markup.
- Markup Palettes let you associate a marker with a colour. When you use that marker in your dialogue, the text will be rendered using that colour.
- For example, consider the following line:
```
I'm [excited]thrilled to be here[/excited]!
```
If you create a Markup Palette that links the word `excited` to the colour red, the words "thrilled to be here" will be red.
- The built-in Line View and Options List View prefabs have support for Markup Palettes, as well as any custom Dialogue Views you build that use the `LineView` and `OptionsListView` classes.
#### Other Features
- A new method (`ClearLoadedAssets`), which unloads all cached assets from the `UnityLocalisedLineProvider`, has been added.
- This method will forcibly unload all assets. Only call this method if you're very familiar with the Addressable Assets system and are comfortable with Yarn Spinner's internals!
- Projects can now provide a list of line IDs within a node, using `GetLineIDsForNodes`.
- This is intended to be used to precache multiple nodes worth of assets, but might also be useful for debugging during development.
- Newly created `.yarnproject` files now ignore any `.yarn` files that are in a folder whose name ends in '~', which follows Unity's behaviour.
- You can customise this behaviour by opening the `.yarnproject` file in a text editor and modifying the `excludeFiles` property.
- Added `MarkupPalette` scriptable object and support for the palette inside of `LineView` and `OptionsListView` and associated `OptionView`.
- This is useful both as a standalone way to easily annotate your dialogue, but also as an example of the markup system.
### Changed
- Fixed a bug where `YarnNode` attributes would not display correctly in the Inspector when its property path is longer than 1.
- Fixed a bug in the action registration source code generator that caused it to crash on certain files, which resulted in some commands not being registered at runtime.
- Replaced the call to `Yarn.Compiler.Utility.AddTagsToLines` with `Yarn.Compiler.Utility.TagLines`.
- Fixed incorrect order of generic parameter names for `AddFunction` methods. The usage of these functions is unchanged.
- Fixed incorrect handling of line IDs inside the Unity Localised Line Provider preventing voice assets being loaded.
- Fixed a crash where declaration statements without a value (`<<declare $var>>`) would crash the importer, leading to _weird_ bugs.
- Yarn Functions and Commands can now have up to 10 parameters if you need them. (Previously, the limit was 6.)
- The hard dependency on Text Mesh Pro is now a soft one.
- This change will only affect projects that do not have TextMeshPro installed in their project. For most projects, this change won't be noticed.
- Dialogue Runner will now better wait for line providers to be ready before requesting lines.
- This does have the potential issue of long load times for some larger nodes, in those cases we suggest you preload more lines using `GetLineIDsForNodes` on `YarnProject`
- `UnityLocalisedLineProvider` can now have its default setting of removing unused assets disabled, this is useful when caching multiple nodes worth of assets
- The "Add Assets to Asset Table Collection" wizard now correctly prepends `line:` to the key, to match the documented behaviour.
- `OptionsListView` now deactivates child options when they are not needed instead of just making them transparent.
- When using Unity Localization, line metadata is now stored on the shared entry for a line ID, rather than only on the base language's entry. (This caused an issue where, if the game was not running in the base language, line metadata would not be available.)
- Fixed an issue with `AudioLineProvider` that would prevent audio assets being loaded
- Fixed an issue with the Project editor that prevented audio assets loading when using Addressables.
- The Yarn Project inspector window will now log errors when your inspector width is considered too small.
- We are pretty sure this is a bug in the UI code on Unity's end.
- In our testing it happens at widths less than 319 pixels, because, sure, why not!
- It also doesn't seem to happen in every version of Unity, so that's fun.
- Setting a project on the dialogue runner will now also load the initial variables from this project, fixing this regression.
- `LineView` now supports showing the character names as a standalone element.
- The existing behaviour is still the same with the default prefabs
- `OptionsListView` now supports showing the character names as a standalone element.
- `LineView` now uses the `PausableTypewriter` by default.
- If you don't use pauses, you won't need to change anything.
- `Effects.Typewriter` now is a wrapper into the `PausableTypewriter` effect
- If you don't use pauses nothing will change
- Yarn Projects that have no import data will no longer suggest to upgrade the project file.
- This solves an uncommon but *very* hard to debug error!
- `YarnProjectImporterEditor.CreateUpgradeUI` is now private.
- The Yarn Project editor 'upgrade' help link now correctly links to the upgrade page on the docs.
### Removed
- Deprecated `SaveStateToPlayerPrefs` and `LoadStateFromPlayerPrefs`.
- Please use `SaveStateToPersistentStorage` and `LoadStateFromPersistentStorage` instead.
- The Actions class will no longer log every single time a command is registered.
- Removed `YarnLinesAsCanvasText` class and associated elements, this didn't do anything and was using an approach that is no longer advisable.
- The `MainMenu` sample is now gone, this code was not in the package and didn't work, so it is unlikely anyone will notice this has been removed.
- Removed the deprecated code inside `YarnProjectImporterEditor`.
- The Addressable sample has been removed for now as it isn't well suited as an example of using Yarn Spinner and Addressables. It will return in a future release of Yarn Spinner.
## [2.3.1] 2023-07-07
### Added
- Added the ability to add, modify, and delete source file patterns for Yarn projects in the Inspector.
### Changed
- Calling `Stop` on the Dialogue Runner will now also dismiss the LineView, OptionListView, and VoiceOverView.
## [2.3.0-beta2] 2023-05-17
### Added
- The `YarnScriptTemplate.txt` now has a newline at the end of the file.
- The `.yarnproject` importer has been updated to use new JSON-formatted Yarn Projects.
- JSON-formatted Yarn Projects replace the previous format, which stored all import data in Unity's `.meta` files.
- JSON-formatted Yarn Projects allow a single Yarn script to be used in multiple Yarn Projects, and also allow the Yarn Spinner compiler to support upcoming new features.
- Yarn scripts no longer need to be manually associated with a Yarn Project. If they are in the same folder, or a subfolder, of the Yarn Project, they will be included.
- When you update to 2.3.0-beta2, all Yarn scripts and Yarn Projects will be re-imported.
- **You will receive import errors on your existing Yarn Projects**, telling you that your Yarn Project needs to be upgraded. To do this, follow the message's instructions: select the project, and click Upgrade Yarn Project in the Inspector.
- After upgrading your projects, **you will need to set up your localisations again** by adding them in the Yarn Project's inspector and dragging in your strings file and asset file.
- If your project uses any Yarn files that are not in the same folder, or subfolder, of the Yarn Project, **you will need to move the Yarn files** to the folder.
- Your Yarn scripts, strings files, and localised assets will not be modified, and you won't need to change any objects in your scenes or prefabs. The only thing that will be changed is the Yarn Project file.
- The Unity Localization integration is now available when the Localization package is installed.
- Prior to this change, the `YARN_USE_EXPERIMENTAL_FEATURES` scripting definition symbol needed to be added to the Player settings.
- You can now add a Dialogue System prefab to your scene by opening the GameObject menu and choosing Yarn Spinner -> Dialogue Runner.
- Added 'On Dialogue Start' event to Dialogue Runner. This event is called when the dialogue starts running. (@nrvllrgrs)
### Changed
- TextMeshPro dependency is now optional. Example dialogue views will not function properly without TMP. As of 2023.2.0a14 TMP has been merged into UGUI.
- Added code to invalidate the Program cache on awake for Yarn Projects properly. This means your Yarn Projects will be correctly compiled and referenced in the editor.
- Dialogue Runner will now report an error and stop early if you tell it to start running a node that isn't in the provided Yarn Project.
- Dialogue Runner's 'On Dialogue Complete' event will now fire when you stop it via by calling the `Stop()` method.
### Removed
## [2.3.0-beta1] 2023-03-06
### Added
- Methods tagged with the `YarnCommand` and `YarnFunction` attribute are now discovered at compile time, rather than at run-time. This makes game start-up significantly faster.
- Yarn Spinner for Unity will search your source code for methods with the `YarnCommand` and `YarnFunction` attributes, and generate source code that registers these methods when the game starts up, or when you enter Play Mode in the editor.
This is a change from previous versions of Yarn Spinner for Unity, which searched for commands and functions at run-time, which had performance and compatibility implications on certain platforms (notably, consoles).
This search is done automatically in Unity 2021.2 and later. In earlier versions of Unity, you will need to manually tell Yarn Spinner for Unity to check your code, by opening the Window menu and choosing Yarn Spinner -> \mands.
- In Unity 2021.2 and later, you can now see which commands have been registered using `YarnCommand` by opening the Window menu and choosing Yarn Spinner -> Commands...
- `DialogueReference` objects can now be implicitly converted to `string`s.
- The `YarnNode` attribute can be attached to a `string` property to turn it into a drop-down menu for choosing nodes in a Yarn Project.
```csharp
// A reference to a Yarn Project
public YarnProject project;
// A node in 'project'
[YarnNode(nameof(project))]
public string node1;
// Another node in 'project'
[YarnNode(nameof(project))]
public string node2;
```
- The `YarnProject.GetHeaders` method has been added, which fetches all headers for a node.
- The `YarnProject.InitialValues` property has been added, which fetches a dictionary containing the initial values for every variable in the project.
### Changed
- Fixed a compile error in the Minimal Viable Dialogue System sample in Unity 2019.
## [2.2.4] 2023-01-27
### Changed
- Number pluralisation rules have been updated. The rules have now use CLDR version 42.0 (previously, 36.1)
- Fixed an issue where pluralisation markup (i.e. the `plural` and `ordinal` tags) would not work correctly with country-specific locales (for example "en-AU").
## [2.2.3] 2022-11-14
### Changed
- Dependency DLLs are now aliased to prevent compilation errors with Burst.
- In v2.2.2, Yarn Spinner's dependency DLLs were renamed to have the prefix `Yarn.` to prevent errors when two DLLs of the same name (e.g. `Google.Protobuf.dll`) are present in the same project.
- This fix solved the edit-time problem, but introduced a new error when the project used Unity's Burst compiler, which looks for DLL files based on their assembly name.
- When compiling with Burst, Unity looks for the DLL file based on the name of the assembly, so when it goes searching for (for example) `Google.Protobuf`, it will _only_ look for the file `Google.Protobuf.dll`, and not the renamed file.
- With this change, the `update_dlls.yml` build script, which pulls in the latest version of Yarn Spinner and its dependencies, now uses the [dotnet-assembly-alias](https://github.com/getsentry/dotnet-assembly-alias/) tool to rename the DLLs _and_ their assembly names.
## [2.2.2] 2022-10-31
### Added
- The `DialogueReference` class, which stores a reference to a named node in a given project (and shows a warning in the Inspector if the reference can't be found) has been added. Thanks to [@sttz](https://github.com/sttz) for the [contribution](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/pull/189)!
- Initial work on support for the Unity Localization system has been added.
- These features are currently behind a feature flag. They are not yet considered ready for production use, and we aren't offering support for it yet.
- To access them, add the scripting define symbol `YARN_ENABLE_EXPERIMENTAL_FEATURES`. You should only do this if you know what this involves.
- Yarn Project importer now has initial support for Unity's Localization system.
- A new localised line provider subclass, `UnityLocalisedLineProvider.cs` has been added.
### Changed
- Fixed interrupt token handling in `VoiceOverView` that would cause it to permanently stop a Dialogue Runner's ability to progress through dialogue lines.
- Fixed an issue where lines and options that contain invalid markup would cause an exception to be thrown, breaking dialogue. A warning message is now logged instead, and the original text of the line (with any invalid markup present) is delivered.
- Fixed a compiler error that made Yarn Spinner fail to compile on Unity 2020.1.
- The `AddCommandHandler(string name, Delegate handler)` and `AddFunction(string name, Delegate handler)` methods on `DialogueRunner` are now `public`.
- These methods allow you to register a `Delegate` object as a command or function.
> **Note:**
> We recommand that you use the pre-existing `AddCommandHandler` and `AddFunction` methods that take `System.Action` or `System.Func` parameters unless you have a very specific reason for using this, as the pre-existing methods allow the compiler to do type-checking on your command and function implementations.
- Fixed an issue that would cause compilation errors if a Unity project using Yarn Spinner also used a DLL with the same name as one of Yarn Spinner's dependencies (for example Google Protocol Buffers).
- The dependency DLLs that come with Yarn Spinner (for example, `Antlr.Runtime`, `Google.Probuf`, and others) have been renamed to have the prefix `Yarn.`, and the assembly definition files for Yarn Spinner have been updated to use the renamed files.
- Huge thanks to [@Sygan](https://github.com/Sygan) for finding and describing [the fix for this problem](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/issues/15#issuecomment-1036162152)!
- The `YarnProject.GetProgram()` method has been replaced with a property, `Program`.
- `GetProgram()` still exists, but has been marked as obsolete and will be removed in a future release of Yarn Spinner.
- `YarnSpinner.Program` has better performance, because it caches the result of de-serializing the compiled Yarn Program.
## [2.2.1] 2022-06-14
### Changed
- Fixed an issue where Yarn projects that made use of the `visited` or `visit_count` functions could produce errors when re-importing the project.
## [2.2.0] 2022-04-08
### Added
- A simple, built-in system for saving and loading Yarn variables to the built-in PlayerPrefs object has been added.
- Call `DialogueRunner.SaveStateToPlayerPrefs` to save all variables to the `PlayerPrefs` system, and `DialogueRunner.LoadStateFromPlayerPrefs` to load from `PlayerPrefs` into the variable storage.
- These methods do not write to file (except via `PlayerPrefs`, which handles disk writing on its own), and only work with variables (and not information like which line is currently being run.)
- Metadata for each line is exposed through a Yarn Project. Metadata generally comes as hashtags similar to `#line`. They can be used to define line-specific behavior (no particular behavior is supported by default, each user will need to define their own).
- When exporting Strings files, a Yarn Project will also export another CSV file with the line metadata (for each line with metadata).
- `LocalizedLine`s now contain a field for any metadata associated with the line.
- `YarnFunction` tagged methods now appear in the inspector window for the project, letting you view their basic info.
### Changed
- `YarnPreventPlayMode` no longer uses `WeakReference` pointing to `Unity.Object` (this is unsupported by Unity).
- `ActionManager` no longer logs every single command that it registers. (#165)
- Line view should no longer have unusual interactions around enabling and disabling different effects (#161 and #153).
- Improved the type inference system around the use of functions.
- Fixed exception when viewing a Yarn Project in the inspector that contains no declarations, in Unity 2021.2 and earlier (#168)
This has two pieces, the first is in YarnSpinner Core and adds in support for partial backwards type inference.
This means in many situations where either the l-value or r-value of an expression is known that can be used to provide a type to the other side of the equation.
Additionally now functions tagged with the `YarnFunction` attribute are sent along to the compiler so that they can be used to inform values.
The upside of this is in situations like `<<set $cats = get_cats()>>` if either `$cats` is declared or `get_cats` is tagged as a `YarnFunction` there won't be an error anymore.
### Removed
- The `SerializeAllVariablesToJSON` and `DeserializeAllVariablesFromJSON` methods have been removed.
- If you need a simple way to save all variables, use `DialogueRunner.SaveStateToPlayerPrefs` and `DialogueRunner.LoadStateFromPlayerPrefs` instead, which save directly to Unity's PlayerPrefs system and don't require reading or writing files.
- If your saving or loading needs are more complex, use the `VariableStorageBehaviour` class's `GetAllVariables()` and `SetAllVariables()` methods to get and set the value of all values at once, and handle the serialization and deserialization the way your game needs it.
## [2.1.0] 2022-02-17
### Dialogue View API Update
The API for creating new Dialogue Views has been updated.
> **Background:** Dialogue Views are objects that receive lines and options from the Dialogue Runner, present them to the player, receive option selections, and signal when the user should see the next piece of content. They're subclasses of the [`DialogueViewBase`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase) class. All of our built-in Dialogue Views, such as [`LineView`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.lineview) and [`OptionsListView`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.optionslistview), are examples of this.
Previously, line objects stored information about their current state, and as Dialogue Views reported that they had finished presenting or dismissing their line, all views would receive a signal that the line's state had changed, and respond to those changes by changing the way that the line was presented (such as by dismissing it when the line's state became 'Dismissed'). This meant that every Dialogue View class needed to implement fairly complex logic to handle these changes in state.
In this release, 'line state' is no longer a concept that Dialogue Views need to keep track of. Instead, Dialogue Views that present lines simply need to implement three methods:
- [`RunLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase/yarn.unity.dialogueviewbase.runline) is called when the Dialogue Runner wants to show a line to the player. It receives a line, as well as a completion handler to call when the line view has finished delivering the contents line.
- [`InterruptLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase/yarn.unity.dialogueviewbase.interruptline) is called when the Dialogue Runner wants all Dialogue Views to finish presenting their lines as fast as possible. It receives the line that's currently being presented, as well as a new completion handler to call when the presentation is finished (which this method should try and call as quickly as it can.)
- [`DismissLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase/yarn.unity.dialogueviewbase.dismissline) is called when all Dialogue Views have finished delivering their line (whether it was interrupted, or whether it completed normally). It receives a completion handler to call when the dismissal is complete.
The updated flow is this:
1. While running a Yarn script, the Dialogue Runner encounters a line of dialogue to show to the user.
2. It calls [`RunLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase/yarn.unity.dialogueviewbase.runline) on all Dialogue Views, and waits for all of them to call their completion handler to indicate that they're done presenting the line.
* At any point, a Dialogue View can call a method that requests that the current line be interrupted. When this happens, the Dialogue Runner calls [`InterruptLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase/yarn.unity.dialogueviewbase.interruptline) on the Dialogue Views, and waits for them to call the new completion handler to indicate that they've finished presenting the line.
3. Once all Dialogue Views have reported that they're done, the Dialogue Runner calls [`DismissLine`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueviewbase/yarn.unity.dialogueviewbase.dismissline) on all Dialogue Views, and waits for them to call the completion handler to indicate that they're done dismissing the line.
4. The Dialogue Runner then moves on to the next piece of content.
This new flow significantly simplifies the amount of information that a Dialogue View needs to keep track of, as well as the amount of logic that a Dialogue View needs to have to manage this information.
Instead, it's a simpler model of: "when you're told to run a line, run it, and tell us when you're done. When you're told to interrupt the line, finish running it ASAP and tell us when you're done. Finally, when you're told to dismiss your line, do it and let us know when you're done."
We've also moved the user input handling code out of the built-in [`LineView`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.lineview) class, and into a new class called [`DialogueAdvanceInput`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialogueadvanceinput). This class lets you use either of the Unity Input systems to signal to a DialogueView that the user wants to advance the dialogue; by moving it out of our built-in view, it's a little easier for Dialogue View writers, who may not want to have to deal with input.
This hopefully alleviates some of the pain points in issues relating to how Dialogue Views work, like [issue #95](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/issues/95).
There are no changes to how options are handled in this new API.
### Jump to Expressions
- The `<<jump>>` statement can now take an expression.
```yarn
<<set $myDestination = "Home">>
<<jump {$myDestination}>>
```
- Previously, the `jump` statement required the name of a node. With this change, it can now also take an expression that resolves to the name of a node.
- Jump expressions may be a constant string, a variable, a function call, or any other type of expression.
- These expressions must be wrapped in curly braces (`{` `}`), and must produce a string.
### Added
- Added a new component, `DialogueAdvanceInput`, which responds to user input and tells a Dialogue View to advance.
- Added `DialogueViewBase.RunLine` method.
- Added `DialogueViewBase.InterruptLine` method.
- Added `DialogueViewBase.DismissLine` method.
### Changed
- Updated to Yarn Spinner Core 2.1.0.
- Updated `DialogueRunner` to support a new, simpler API for Dialogue Views; lines no longer have a state for the Dialogue Views to respond to changes to, and instead only receive method calls that tell them what to do next.
- Fixed a bug where changing a Yarn script asset in during Play Mode would cause the string table to become empty until the next import (#154)
- Fixed a bug where Yarn functions outside the default assembly would fail to be loaded.
### Removed
- Removed `LineStatus` enum.
- Removed `DialogueViewBase.OnLineStatusChanged` method.
- Removed `DialogueViewBase.ReadyForNextLine` method.
- Removed `VoiceOverPlaybackFmod` class. (This view was largely unmaintained, and we feel that it's best for end users to customise their FMOD integration to suit their own needs.)
- Renamed `VoiceOverPlaybackUnity` to `VoiceOverView`.
## [2.0.2] 2022-01-08
### Added
- You can now specify which assemblies you want Yarn Spinner to search for `YarnCommand` and `YarnFunction` methods in.
- By default, Yarn Spinner will search in your game's code, as well as every assembly definition in your code and your packages.
- You can choose to make Yarn Spinner only look in specific assembly definitions, which reduces the amount of time needed to search for commands and functions.
- To control how Yarn Spinner searches for commands and actions, turn off "Search All Assemblies" in the Inspector for a Yarn Project.
- Added a Spanish translation to the Intro sample.
### Changed
- ActionManager now only searches for commands and actions in assemblies that Yarn Projects specify. This significantly reduces startup time and memory usage.
- Improved error messages when calling methods defined via the `YarnCommand` attribute where the specified object can't be found.
## [2.0.1] 2021-12-23
### Added
- The v1 to v2 language upgrader now renames node names that have a period (`.`) in their names to use underscores (`_`) instead. Jumps and options are also updated to use these new names.
### Changed
- Fixed a crash in the compiler when producing an error message about an undeclared function.
- Fixed an error when a constant float value (such as in a `<<declare>>` statement) was parsed and the user's current locale doesn't use a period (`.`) as the decimal separator.
## [2.0.0-rc1] 2021-12-13
### Added
- Command parameters can now be grouped with double quotes. eg. `<<add-recipe "Banana Sensations">` and `<<move "My Game Object" LocationName>>` (@andiCR)
- You can now add dialogue views to dialogue runner at any time.
- The inspector for Yarn scripts now allows you to change the Project that the script belongs to. (@radiatoryang)
- Yarn script compile errors will prevent play mode.
- Default functions have been added for convenience.
- `float random()` - returns a number between 0 and 1, inclusive (proxies Unity's default prng)
- `float random_range(float, float)` - returns a number in a given range, inclusive (proxies Unity's default prng)
- `int dice(int)` - returns an integer in a given range, like a dice (proxies Unity's default prng)
- For example, `dice(6) + dice(6)` to simulate two dice, or `dice(20)` for a D20 roll.
- `int round(float)` - rounds a number using away-from-zero rounding
- `float round_places(float, int)` - rounds a number to n digits using away-from-zero rounding
- `int floor(float)` - floors a number (towards negative infinity)
- `int ceil(float)` - ceilings a number (towards positive infinity)
- `int int(float)` - truncates the number (towards zero)
- `int inc(float | int)` - increments to the next integer
- `int dec(float | int)` - decrements to the previous integer
- `int decimal(float)` - gets the decimal portion of the float
- The `YarnFunction` attribute has been added.
- Simply add it to a static function, eg
```cs
[YarnFunction] // registers function under "example"
public static int example(int param) {
return param + 1;
}
[YarnFunction("custom_name")] // registers function under "custom_name"
public static int example2(int param) {
return param * param;
}
```
- The `YarnCommand` attribute has been improved and made more robust for most use cases.
- You can now leave the name blank to use the method name as the registration name.
```cs
[YarnCommand] // like in previous example with YarnFunction.
void example(int steps) {
for (int i = 0; i < steps; i++) { ... }
}
[YarnCommand("custom_name")] // you can still provide a custom name if you want
void example2(int steps) {
for (int i = steps - 1; i >= 0; i--) { ... }
}
```
- It now recognizes static functions and does not attempt to use the first parameter as an instance variable anymore.
```cs
[YarnCommand] // use like so: <<example>>
static void example() => ...;
[YarnCommand] // still as before: <<example2 objectName>>
void example2() => ...;
```
- You can also define custom getters for better performance.
```cs
[YarnStateInjector(nameof(GetBehavior))] // if this is null, the previous behavior of using GameObject.Find will still be available
class CustomBehavior : MonoBehaviour {
static CustomBehavior GetBehavior(string name) {
// e.g., it may only exist under a certain transform, or you have a custom cache...
// or it's built from a ScriptableObject...
return ...;
}
[YarnCommand] // the "this" will be as returned from GetBehavior
void example() => Debug.Log(this);
// special variation on getting behavior
static CustomBehavior GetBehaviorSpecial(string name) => ...;
[YarnCommand(Injector = nameof(GetBehaviorSpecial))]
void example_special() => Debug.Log(this);
}
```
- You can also define custom getters for Component parameters in the same vein.
```cs
class CustomBehavior : MonoBehaviour {
static Animator GetAnimator(string name) => ...;
[YarnCommand]
void example([YarnParameter(nameof(GetAnimator))] Animator animator) => Debug.Log(animator);
}
```
- You should continue to use manual registration if you want to make an instance function (ie where the ["target"](https://docs.microsoft.com/en-us/dotnet/api/system.delegate.target?view=netstandard-2.0) is defined) static.
- Sample scenes now have a render pipeline detector gameobject that will warn when the sample scene materials won't look correct in the current render pipeline.
- Variables declared inside Yarn scripts will now have the default values set into the variable storage.
### Changed
- Updated to support new error handling in Yarn Spinner.
- Yarn Spinner longer reports errors by throwing an exception, and instead provides a collection of diagnostic messages in the compiler result. In Unity, Yarn Spinner will now show _all_ error messages that the compiler may produce.
- The console will no longer report an error indicating that a command is "already defined" when a subclass of a MonoBehaviour that has `YarnCommand` methods exists.
- `LocalizedLine.Text`'s setter is now public, not internal.
- `DialogueRunner` will now throw an exception if a dialogue view attempts to select an
option on the same frame that options are run.
- `DialogueRunner.VariableStorage` can now be modified at runtime.
- Calling `DialogueRunner.StartDialogue` when the dialogue runner is already running will now result in an error being logged.
- Line Views will now only enable and disable action references if the line view is also configured to use said action.
- Yarn Project importer will now save variable declaration metadata on the first time
### Removed
- Support for Unity 2018 LTS has been dropped, and 2019 LTS (currently 2019.4.32f1) will be the minimum supported version. The support scheme for Yarn Spinner will be clarified in the [CONTRIBUTING](./CONTRIBUTING.md) docs. If you still require support for 2018, please join our [Discord](https://discord.gg/yarnspinner)!
## [2.0.0-beta5] 2021-08-17
### Added
* `InMemoryVariableStorage` now throws an exception if you attempt to get or set a variable whose name doesn't start with `$`.
* `LineView` now has an onCharacterTyped event that triggers for each character typed in the typewriter effect.
### Changed
* `OptionsListView` no longer throws a `NullPointerException` when the dialogue starts with options (instead of a line.)
* When creating a new Yarn Project file from the Assets -> Create menu, the correct icon is now used.
* Updated to use the new type system in Yarn Spinner 2.0-beta5.
### Removed
* Yarn Programs: The 'Convert Implicit Declarations' button has been temporarily removed, due to a required compatibility change related to the new type system. It will be restored before final 2.0 release.
## [2.0.0-beta4] 2021-04-01
Yarn Spinner 2.0 Beta 4 is a hotfix release for Yarn Spinner 2.0 Beta 3.
### Changed
- Fixed an issue that caused Yarn Spinner to not compile on Unity 2018 or Unity 2019.
## [2.0.0-beta3] 2021-03-27
### Added
- The dialogue runner can now be configured to log less to the console, reducing the amount of noise it generates there. (@radiatoryang)
- Warning messages and errors now appear to help users diagnose two common problems: (1) not adding a Command properly, (2) can't find a localization entry for a line (either because of broken line tag or bad connection to Localization Database) (@radiatoryang)
- Made options that have a line condition able to be presented to the player, but made unavailable.
- This change was made in order to allow games to conditionally present, but disallow, options that the player can't choose. For example, consider the following script:
```
TD-110: Let me see your identification.
-> Of course... um totally not General Kenobi and the son of Darth Vader.
Luke: Wait, what?!
TD-110: Promotion Time!
-> You don't need to see his identification. <<if $learnt_mind_trick is true>>
TD-110: We don't need to see his identification.
```
- If the variable `$learnt_mind_trick` is false, a game may want to show the option but not allow the player to select it (i.e., show that this option could have been chosen if they'd learned how to do a mind trick.)
- In previous versions of Yarn Spinner, if a line condition failed, the entire option was not delivered to the game. With this change, all options are delivered, and the `OptionSet.Option.IsAvailable` variable contains `false` if the condition was not met, and `true` if it was (or was not present.)
- The `DialogueUI` component now has a "showUnavailableOptions" option that controls the display behaviour of unavailable options. If it's true, then unavailable options are presented, but not selectable; if it's false, then unavailable options are not presented at all (i.e. same as Yarn Spinner 1.0.)
- Audio for lines in a `Localization` object can now be previewed in the editor. (@radiatoryang)
- Lines can be added to a `Localization` object at runtime. They're only stored in memory, and are discarded when gameplay ends.
- Commands that take a boolean parameter now support specifying that parameter by its name, rather than requiring the string `true`.
- For example, if you have a command like this:
```csharp
[YarnCommand("walk")]
void WalkToPoint(string destinationName, bool wait = false) {
// ...
}
```
Previously, you'd need to use this in your Yarn scripts:
```
<<walk MyObject MyDestination true>>
```
With this change, you can instead say this:
```
<<walk MyObject MyDestination wait>>
```
- New icons for Yarn Spinner assets have been added.
- New dialogue views, `LineView` and `OptionListView`, have been added. These are intended to replace the previous `DialogueUI`, make use of TextMeshPro for text display, and allow for easier customisation through prefabs.
- `DialogueRunner`s will now automatically create and use an `InMemoryVariableStorage` object if one isn't provided.
- The Inspector for `DialogueRunner` has been updated, and is now easier to use.
### Changed
- Certain private methods in `DialogueUI` have changed to protected, making it easier to subclass (@radiatoryang)
- Fixed an issue where option buttons from previous option prompts could re-appear in later prompts (@radiatoryang)
- Fixed an issue where dialogue views that are not enabled were still being waited for (@radiatoryang)
- Upgrader tool now creates new files on disk, where needed (for example, .yarnproject files)
- `YarnProgram`, the asset that stores references to individual .yarn files for compilation, has been renamed to `YarnProject`. Because this change makes Unity forget any existing references to "YarnProgram" assets, **when upgrading to this version, you must set the Yarn Project field in your Dialogue Runners again.**
- `Localization`, the asset that mapped line IDs to localized data, is now automatically generated for you by the `YarnProject`.
- You don't create them yourselves, and you no longer need to manually refresh them.
- The `YarnProject` always creates at least one localization: the "Base" localization, which contains the original text found in your `.yarn` files.
- You can create more localizations in the `YarnProject`'s inspector, and supply the language code to use and a `.csv` file containing replacement strings.
- Renamed the 'StartHere' demo to 'Intro', because it's not actually the first step in installing Yarn Spinner.
- Simplified the workflow for working with Addressable Assets.
- You now import the package, enable its use on your Yarn Project, and click the Update Asset Addresses button to ensure that all assets have an address that Yarn Spinner knows about.
- The 3D, VisualNovel, and Intro examples have been updated to use the new `LineView` and `OptionsListView` components, rather than `DialogueUI`.
- `DialogueRunner.ResetDialogue` is now marked as Obsolete (it had the same effect as just calling `StartDialogue` anyway.)
- The `LineStatus` enum's values have been renamed, to better convey their purpose:
- `Running` is now `Presenting`.
- `Interrupted` remains the same.
- `Delivered` is now `FinishedPresenting`.
- `Ended` is now `Dismissed` .
- The `ResetDialogue()` method now takes an optional parameter to restart from. If none is provided, the dialogue runner attempts to restart from the start node, followed by the current node, or else throws an exception.
- `DialogueViewBase.MarkLineComplete`, the method for signalling that the user wants to interrupt or proceed to the next line, has been renamed to `ReadyForNextLine`.
- `DialogueRunner.continueNextLineOnLineFinished` has been renamed to `automaticallyContinueLines`.
### Removed
- `LocalizationDatabase`, the asset that stored references to `Localization` assets and manages per-locale line lookups, has been removed. This functionality is now handled by `YarnProject` assets. You no longer supply a localization database to a `DialogueRunner` or to a `LineProvider` - the work is handled for you.
- `AddressableAudioLineProvider` has been removed. `AudioLineProvider` now works with addressable assets, if the package is installed and your Yarn Project has been configured to use them.
- You no longer specify a list of languages available to your project in the Preferences menu or in the project settings. This is now controlled from the Yarn Project.
- The `StartDialogue()` method (with no parameters) has been removed. Instead, provide a node name to start from when calling `StartDialogue(nodeName)`.
## [2.0.0-beta2] 2021-01-14
### Added
- InMemoryVariableStorage now shows the current state of variables in the Inspector. (@radiatoryang)
- InMemoryVariableStorage now supports saving variables to file, and to PlayerPrefs. (@radiatoryang)
### Changed
- Inline expressions (for example, `One plus one is {1+1}`) are now expanded.
- Added Help URLs to various classes. (@radiatoryang)
- The Upgrader window (Window -> Yarn Spinner -> Upgrade Scripts) now uses the updated
Yarn Spinner upgrade tools. See Yarn Spinner 2.0.0-beta2 release notes for more
information on the upgrader.
- Fixed an issue where programs failed to import if a source script reference is invalid
- Fixed an issue where the DialogueUI would show empty lines when showCharacterName is
false and the line has no character name
### Removed
- The `[[Destination]]` and `[[Option|Destination]]` syntax has been removed from the language.
- This syntax was inherited from the original Yarn language, which itself inherited it from Twine.
- We removed it for four reasons:
- it conflated jumps and options, which are very different operations, with too-similar syntax;
- the Option-destination syntax for declaring options involved the management of non-obvious state (that is, if an option statement was inside an `if` branch that was never executed, it was not presented, and the runtime needed to keep track of that);
- it was not obvious that options accumulated and were only presented at the end of the node;
- finally, shortcut options provide a cleaner way to present the same behaviour.
- We have added a `<<jump Destination>>` command, which replaces the `[[Destination]]` jump syntax.
- No change to the bytecode is made here; these changes only affect the compiler.
- Instead of using ``[[Option|Destination]]`` syntax, use shortcut options instead. For example:
```
// Before
Kim: You want a bagel?
[[Yes, please!|GiveBagel]]
[[No, thanks!|DontWantBagel]]
// After
Kim: You want a bagel?
-> Yes, please!
<<jump GiveBagel>>
-> No, thanks!
<<jump DontWantBagel>>
```
- InMemoryVariableStorage no longer manages 'default' variables (this concept has moved to the Yarn Program.) (@radiatoryang)
## [2.0.0-beta1] 2020-10-19
### Added
- Added a 3D speech bubble sample, for dynamically positioning a speech bubble above a game character. (@radiatoryang)
- Added a phone chat sample. (@radiatoryang)
- Added a visual novel template. (@radiatoryang)
- Added support for voice overs. (@Schroedingers-Cat)
- Added a new API for presenting and managing lines of dialogue.
- Added a new API for working with localizations.
- Added an option to DialogueUI to allow hiding character names.
- The Yarn Spinner Window (Window -> Yarn Spinner) now shows the current version of Yarn Spinner.
### Changed
- Individual `.yarn` scripts are now combined into a single 'Yarn Program', which is what you provide to your `DialogueRunner`. You no longer add multiple `.yarn` files to a DialogueRunner. To create a new Yarn Program, open the Asset menu, and choose Create -> Yarn Spinner -> Yarn Program. You can also create a new Yarn Program by selecting a Yarn Script, and clicking Create New Yarn Program.
- Version 2 of the Yarn language requires variables to be declared. You can declare them in your .yarn scripts, or you can declare them in the Inspector for your Yarn Program.
- Variables must always have a defined type, and aren't allowed to change type. This means, for example, that you can't store a string inside a variable that was declared as a number.
- Variables also have a default value. As a result, variables are never allowed to be `null`.
- Variable declarations can be in any part of a Yarn script. As long as they're somewhere in the file, they'll be used.
- Variable declarations don't have to be in the same file as where they're used. If the Yarn Program contains a script that has a variable declaration, other scripts in that Program can use the variable.
- To declare a variable on a Yarn Program, select it, and click the `+` button to create the new variable.
- To declare a variable in a script, use the following syntax:
```
<<declare $variable_name = "hello">> // declares a string
<<declare $variable_name = 123>> // declares a number
<<declare $variable_name = true>> // declares a boolean
```
- Nicer error messages when the localized text for a line of dialogue can't be found.
- DialogueUI is now a subclass of DialogueViewBase.
- Moved Yarn Spinner classes into the `Yarn.Unity` namespace, or one of its children, depending on its purpose.
- Dialogue.AddFunction now uses functions that can take multiple parameters. You no longer use a single `Yarn.Value[]` parameter; you can now have up to 5, which can be strings, integers, floats, doubles, bools, or `Yarn.Value`s.
- Commands registered via the `YarnCommand` attribute can now take parameter types besides strings. Parameters can also be optional. Additionally, these methods are now cached, and are faster to call.
### Removed
- Commands registered via the `YarnCommand` attribute can no longer accept a `params` array of parameters. If your command takes a variable number of parameters, use optional parameters instead.
## [1.2.7]
### Changed
- Backported check for Experimental status of AssetImporter (promoted in 2020.2)
## [1.2.6]
Note: Versions 1.2.1 through 1.2.5 are identical to v1.2.0; they were version number bumps while we were diagnosing an issue in OpenUPM.
### Changed
- Fixed compiler issues in Unity 2019.3 and later by adding an explicit reference to YarnSpinner.dll in YarnSpinnerTests.asmdef
## [1.2.0] 2020-05-04
This is the first release of v1.2.0 of Yarn Spinner for Unity as a separate project. Previously, this project's source code was part of the Yarn Spinner repository. Version 1.2.0 of Yarn Spinner contains an identical release to this.
### Added
- Yarn scripts now appear with Yarn Spinner icon. (@Schroedingers-Cat)
- Documentation is updated to reflect the current version number (also to mention 2018.4 LTS as supported)
- Added a button in the Inspector for `.yarn` files in Yarn Spinner for Unity, which updates localised `.csv` files when the `.yarn` file changes. (@stalhandske, https://github.com/YarnSpinnerTool/YarnSpinner/issues/227)
- Added handlers for when nodes begin executing (in addition to the existing handlers for when nodes complete.) (@arendhil, https://github.com/YarnSpinnerTool/YarnSpinner/issues/222)
- `OptionSet.Option` now includes the name of the node that an option will jump to if selected.
- Added unit tests for Yarn Spinner for Unity (@Schroedingers-Cat)
- Yarn Spinner for Unity: Added a menu item for creating new Yarn scripts (Assets -> Create -> Yarn Script)
- Added Nuget package definitions for [YarnSpinner](http://nuget.org/packages/YarnSpinner/) and [YarnSpinner.Compiler](http://nuget.org/packages/YarnSpinner.Compiler/).
### Changed
- Fixed a crash in the compiler when parsing single-character commands (e.g. `<<p>>`) (https://github.com/YarnSpinnerTool/YarnSpinner/issues/231)
- Parse errors no longer show debugging information in non-debug builds.
Reference in New Issue View Git Blame Copy Permalink