diff options
| author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2022-02-19 11:07:26 -0500 |
|---|---|---|
| committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2022-02-19 11:07:26 -0500 |
| commit | 2d52681b1034d314d8d56c561a5aa72e54e34576 (patch) | |
| tree | 8c7e87bb6130166ee31b3a659229218f0cedf56b /docs | |
| parent | a2190df08cc3f1b4a8dcb394056d65921d10702e (diff) | |
| download | SMAPI-2d52681b1034d314d8d56c561a5aa72e54e34576.tar.gz SMAPI-2d52681b1034d314d8d56c561a5aa72e54e34576.tar.bz2 SMAPI-2d52681b1034d314d8d56c561a5aa72e54e34576.zip | |
add Constants.GamePath & deprecate Constants.ExecutionPath
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release-notes.md | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md index b84f8a06..4cbd1ad9 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -4,20 +4,27 @@ ## Upcoming release * For players: * Improved translations. Thanks to ChulkyBow (updated Ukrainian)! + * Fixed `player_add` console command's handling of Journal Scraps and Secret Notes. * For mod authors: - * Added `IAssetName` field to the asset info received by `IAssetEditor` and `IAssetLoader` methods. - _This provides utility methods for working with asset names, parsed locales, etc. The `asset.AssetNameEquals` method is now deprecated in favor of `asset.Name.IsEquivalentTo`_. - * The `SDate` constructor is no longer case-sensitive for season names. - * Fixed issue where suppressing `[Left|Right]Thumbstick[Down|Left]` keys would suppress the opposite direction instead. + * Added `IAssetName Name` field to the info received by `IAssetEditor` and `IAssetLoader` methods. + _This adds methods for working with asset names, parsed locales, etc._ + * Fixed the `SDate` constructor being case-sensitive. * Fixed support for using locale codes from custom languages in asset names (e.g. `Data/Achievements.eo-EU`). + * Fixed issue where suppressing `[Left|Right]Thumbstick[Down|Left]` keys would suppress the opposite direction instead. -* For console commands: - * Fixed `player_add` with Journal Scraps and Secret Notes. +* **Deprecation warning for mod authors:** + These APIs are now deprecated and will be removed in the upcoming SMAPI 4.0.0. + + API | how to update code + :-- | :----------------- + `Constants.ExecutionPath` | Use `Constants.GamePath` instead. + `IAssetInfo.AssetName`<br />`IAssetData.AssetName` | Use `Name` instead, which changes the type from `string` to the new `AssetName`. + `IAssetInfo.AssetNameEquals`<br />`IAssetData.AssetNameEquals` | Use `Name.IsEquivalentTo` instead. * For the web UI: * Added `data-*` attributes to log parser page for external tools. - * Fixed JSON validator warning for update keys without a subkey. + * Fixed JSON validator warning shown for update keys without a subkey. ## 3.13.4 Released 16 January 2022 for Stardew Valley 1.5.6 or later. |