You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: assets/Changelog.md
+34-11Lines changed: 34 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,14 @@ some notes about most important changes such as:
9
9
10
10
## New
11
11
Added support for UE Version 5.5 - ([UE4SS #708](https://github.com/UE4SS-RE/RE-UE4SS/pull/708))
12
+
12
13
Added support for UE Version 5.4 - ([UE4SS #503](https://github.com/UE4SS-RE/RE-UE4SS/pull/503))
14
+
13
15
Added basic support for Development/Debug/Test built Unreal Engine games ([UE4SS #607](https://github.com/UE4SS-RE/RE-UE4SS/pull/607))
14
16
- To use this functionality, set DebugBuild to true in UE4SS-Settings.ini
15
17
16
18
Added new build definition "LessEqual421". Using this definition for games on UE<=4.21 is not mandatory for UE4SS to function, but will ensure the correct alignment is used in containers.
19
+
17
20
**BREAKING:** - This also changes the default FName alignment from 8 to 4.
18
21
- To use this functionality, enter LessEqual421 in the <Target> section of the XMake configuration command.
@@ -45,28 +50,39 @@ Added global Dumpers functions to Types.lua. ([UE4SS #664](https://github.com/UE
45
50
- Added `FName` function overloads with FindType parameter
46
51
47
52
#### UEHelpers
48
-
- Added function `GetPlayer` which is just a fast way to get player controlled Pawn (the majority of the time it will be the player character) [PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
- Added functions to get static objects: `GetKismetStringLibrary`, `GetKismetTextLibrary`[PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
51
-
- Added function `GetActorFromHitResult` which extracts the hit actor from a `FHitResult` struct based on UE's version [PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
53
+
- Added function `GetPlayer` which is just a fast way to get player controlled Pawn (the majority of the time it will be the player character) [PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
- Added functions to get static objects: `GetKismetStringLibrary`, `GetKismetTextLibrary`[PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
58
+
59
+
- Added function `GetActorFromHitResult` which extracts the hit actor from a `FHitResult` struct based on UE's version [PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
-`FindFName`: wrapper for `FName(Name, EFindName.FNAME_Find)`
54
-
-`AddFName`: wrapper for `FName(Name, EFindName.FNAME_Add)`
55
-
- Added [Lua Server Annotations](https://luals.github.io/wiki/annotations/) to all UEHelpers functions [PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
63
+
-`AddFName`: wrapper for `FName(Name, EFindName.FNAME_Add)`
64
+
65
+
- Added [Lua Server Annotations](https://luals.github.io/wiki/annotations/) to all UEHelpers functions [PR #650](https://github.com/UE4SS-RE/RE-UE4SS/pull/650)
66
+
56
67
- Added functions `GetAllPlayerStates` and `GetAllPlayers`[PR #688](https://github.com/UE4SS-RE/RE-UE4SS/pull/688)
57
68
58
69
### C++ API
59
70
Key binds created with `UE4SSProgram::register_keydown_event` end up being duplicated upon mod hot-reload.
71
+
60
72
To fix this, `CppUserModBase::register_keydown_event` has been introduced.
73
+
61
74
It's used exactly the same way except without the `UE4SSProgram::` part. ([UE4SS #446](https://github.com/UE4SS-RE/RE-UE4SS/pull/446))
62
75
63
76
Added `on_ui_init()`, it fires when the UI is initialized.
77
+
64
78
It's intended to use the `UE4SS_ENABLE_IMGUI` macro in this function.
79
+
65
80
Failing to do so will cause a crash when you try to render something with imgui.
66
81
67
82
BREAKING: Changed `FTransform` constructor to be identical to unreal.
68
83
69
84
Added `OpenFor::ReadWrite`, to be used when calling `File::open`.
85
+
70
86
This can be used when calling `FileHandle::memory_map`, unlike `OpenFor::Writing`. ([UE4SS #507](https://github.com/UE4SS-RE/RE-UE4SS/pull/507))
71
87
72
88
### BPModLoader
@@ -78,6 +94,7 @@ This can be used when calling `FileHandle::memory_map`, unlike `OpenFor::Writing
78
94
79
95
### General
80
96
Changed the default location of the UE4SS release assets to be in `game executable directory/ue4ss/`. This change is backwards compatible with the old location. ([UE4SS #506](https://github.com/UE4SS-RE/RE-UE4SS/pull/506)) - Buckminsterfullerene
- Reworked all UEHelpers functions to ensure that they always return an object which can be checked with the function `IsValid` for validation
107
-
- Reworked `UEHelpers.GetPlayerController` to return first valid player controller (It will now return a player controller even if it doesn't control a pawn at the time)
108
-
- Reworked `UEHelpers.GetWorld` function to use UWorld cache (UWorld usually never changes)
109
-
- Change `UEHelpers.GetWorldContextObject` function annotation to return `UObject`. (Any UObject with a GetWorld() function is a valid WorldContext)
122
+
- Increased version to 3
123
+
124
+
- Reworked all UEHelpers functions to ensure that they always return an object which can be checked with the function `IsValid` for validation
125
+
126
+
- Reworked `UEHelpers.GetPlayerController` to return first valid player controller (It will now return a player controller even if it doesn't control a pawn at the time)
127
+
128
+
- Reworked `UEHelpers.GetWorld` function to use UWorld cache (UWorld usually never changes)
129
+
130
+
- Change `UEHelpers.GetWorldContextObject` function annotation to return `UObject`. (Any UObject with a GetWorld() function is a valid WorldContext)
131
+
110
132
- Removed duplicate function `UEHelpers.GetKismetMathLibrary`
111
133
112
134
### C++ API
@@ -116,6 +138,7 @@ BPModLoader now supports loading mods from subdirectories within the `LogicMods`
The console keys **F10** and **~** are now added by the mod in addition to the existing keys instead of replacing them ([UE4SS #687](https://github.com/UE4SS-RE/RE-UE4SS/pull/687))
0 commit comments