release(skyrim-platform): version 2.9 (skyrim-multiplayer#1962)

rethesda · May 13, 2024 · f3b803f · f3b803f
1 parent 5b7165a
commit f3b803f
Show file tree

Hide file tree

Showing 27 changed files with 77 additions and 26 deletions.
diff --git a/docs/release/dev/sp-add-TESModPlatform-CloseMenu.md b/docs/release/dev/sp-add-TESModPlatform-CloseMenu.md
diff --git a/docs/release/dev/sp-add-TESModPlatform-CreateReferenceAtLocation.md b/docs/release/dev/sp-add-TESModPlatform-CreateReferenceAtLocation.md
diff --git a/docs/release/dev/sp-added-evaluate-lvl-character.md b/docs/release/dev/sp-added-evaluate-lvl-character.md
diff --git a/docs/release/dev/sp-block-papyrus-events.md b/docs/release/dev/sp-block-papyrus-events.md
diff --git a/docs/release/dev/sp-cmd-fix.md b/docs/release/dev/sp-cmd-fix.md
diff --git a/docs/release/dev/sp-fix-bow-shot-event.md b/docs/release/dev/sp-fix-bow-shot-event.md
diff --git a/docs/release/dev/sp-fix-cameraStateChanged-event-crash.md b/docs/release/dev/sp-fix-cameraStateChanged-event-crash.md
diff --git a/docs/release/dev/sp-fix-const-enum.md b/docs/release/dev/sp-fix-const-enum.md
diff --git a/docs/release/dev/sp-fix-effectStart-effectFinish-crash.md b/docs/release/dev/sp-fix-effectStart-effectFinish-crash.md
diff --git a/docs/release/dev/sp-fix-event-crash.md b/docs/release/dev/sp-fix-event-crash.md
diff --git a/docs/release/dev/sp-fix-loadgame-headparts.md b/docs/release/dev/sp-fix-loadgame-headparts.md
diff --git a/docs/release/dev/sp-fix-magicEffectApply-crash.md b/docs/release/dev/sp-fix-magicEffectApply-crash.md
diff --git a/docs/release/dev/sp-fix-remaining-event-crashes.md b/docs/release/dev/sp-fix-remaining-event-crashes.md
diff --git a/docs/release/dev/sp-httpclient-callback.md b/docs/release/dev/sp-httpclient-callback.md
diff --git a/docs/release/dev/sp-loadgame.md b/docs/release/dev/sp-loadgame.md
diff --git a/docs/release/dev/sp-no-disable-defaultDisableHavokOnLoad.md b/docs/release/dev/sp-no-disable-defaultDisableHavokOnLoad.md
diff --git a/docs/release/dev/sp-optimize-settings.md b/docs/release/dev/sp-optimize-settings.md
diff --git a/docs/release/dev/sp-optimize-texts.md b/docs/release/dev/sp-optimize-texts.md
diff --git a/docs/release/dev/sp-set-inventory-force.md b/docs/release/dev/sp-set-inventory-force.md
diff --git a/docs/release/dev/sp-support-1.6.1170.md b/docs/release/dev/sp-support-1.6.1170.md
diff --git a/docs/release/dev/sp-tick.md b/docs/release/dev/sp-tick.md
diff --git a/docs/release/sp-2.9.md b/docs/release/sp-2.9.md
@@ -0,0 +1,72 @@
+# SP 2.9.0 Release Notes
+
+Thank you for using Skyrim Platform!
+
+This document includes changes made since SP 2.8.0
+
+WARNING: New game required. Update on current save at your own risk. Please backup your savegames.
+
+This document will tell you more about project status: https://github.com/skyrim-multiplayer/skymp/blob/main/skyrim-platform/README.md
+## Changes
+
+- After a series of individual fixes, all remaining unsafe event handlers have been resolved. **Crashes when loading a save should no longer occur** ❤️‍🩹
+
+
+- Added support for Skyrim 1.6.1170.0 ❤️‍🩹
+
+
+- Added `TESModPlatform.CreateReferenceAtLocation` native
+
+
+- Fixed crash when loading a save with at least one active `effectStart`/`effectFinish` listener.
+
+
+- Slightly optimized Texts API.
+
+
+- Fixed `playerBowShot` event lacking `isSunGazing` value.
+
+
+- Taught `loadGame` function to work with non vanilla headparts.
+
+
+- `blockPapyrusEvents` function now will not block events in `defaultDisableHavokOnLoad` script.
+
+
+- Significantly optimized settings API.
+
+
+- Added `TESModPlatform.CloseMenu` native
+
+
+- `setInventory` now doesn't deny unequipping equipped items by default for the player (still denies for other actors).
+
+
+- Fixed crash during hot-reload after an attempt to register a non-existent event listener.
+
+
+- Added `blockPapyrusEvents` method as an alias for `TESModPlatform.blockPapyrusEvents` which is a Papyrus function and requires `on('update')` context to run.
+
+
+- [Embedded console](https://github.com/skyrim-multiplayer/skymp/blob/592c6527ed91e6c97a38d143f4ae1cdab9c3268e/docs/release/sp-2.8.md?plain=1#L68) now mirrors unhandled exceptions from the game console properly.
+
+
+- Added `time` and `loadOrder` parameters to `loadGame` function.
+
+
+- Fixed runtime errors when bundlers treat const enums in skyrimPlatform.ts as non-const.
+
+
+- Added initial support for calling script functions in tick context: `Game.getModCount`, `Game.getModName`.
+
+
+- Fixed potential crash when loading a save with at least one active `magicEffectApply` listener.
+
+
+- Added experimental `TESModPlatform.EvaluateLeveledNpc` native. It is unstable and shouldn't be used in user plugins. This native is required for SkyMP.
+
+
+- Fixed crash in `CameraStateChanged` event when the player opens world map.
+
+
+- HTTP Client API now supports callbacks, not only promises. This is useful since in SkyrimPlatform promises aren't resolving in the main menu.
diff --git a/skymp5-client/src/version.ts b/skymp5-client/src/version.ts
@@ -1,6 +1,6 @@
 import { Utility, Debug, getPlatformVersion, on, Game, Ui } from 'skyrimPlatform';
 
-export const requiredVersion = '2.8.0';
+export const requiredVersion = '2.9.0';
 
 const realVersion = typeof getPlatformVersion === 'function' ? getPlatformVersion() : 'unknown';
 

diff --git a/skyrim-platform/package.json b/skyrim-platform/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skymp/skyrim-platform",
-  "version": "2.8.0",
+  "version": "2.9.0",
   "description": "A modding tool for Skyrim allowing writing scripts with JavaScript/TypeScript",
   "license": "GPL-3.0"
 }
diff --git a/skyrim-platform/src/platform_se/CMakeLists.txt b/skyrim-platform/src/platform_se/CMakeLists.txt
@@ -1,4 +1,4 @@
-project(platform_se VERSION 2.8.0 LANGUAGES CXX)
+project(platform_se VERSION 2.9.0 LANGUAGES CXX)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/Version.h.in ${CMAKE_CURRENT_BINARY_DIR}/include/Version.h @ONLY)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.rc.in ${CMAKE_CURRENT_BINARY_DIR}/version.rc @ONLY)
 

diff --git a/skyrim-platform/src/platform_se/skyrim_platform/DevApi.cpp b/skyrim-platform/src/platform_se/skyrim_platform/DevApi.cpp
@@ -98,7 +98,7 @@ JsValue DevApi::WritePlugin(const JsFunctionArguments& args)
 
 JsValue DevApi::GetPlatformVersion(const JsFunctionArguments& args)
 {
-  return "2.8.0";
+  return "2.9.0";
 }
 
 JsValue DevApi::GetJsMemoryUsage(const JsFunctionArguments& args)

diff --git a/skyrim-platform/tools/plugin-example/package.json b/skyrim-platform/tools/plugin-example/package.json
@@ -25,6 +25,6 @@
     "skryim platform"
   ],
   "dependencies": {
-    "@skyrim-platform/skyrim-platform": "2.8.0"
+    "@skyrim-platform/skyrim-platform": "2.9.0"
   }
 }