v3.0.1

This is a patch release for 3.0.0. Installing over 3.0 is as simple as replacing all files except for your UE4SS-settings.ini if you have custom configs.

If you have not yet installed since 2.5.2, please see the installation instructions in the v3.0.0 release notes. Remember to delete the old xinput1_3.dll as it crashes the game if you still have it!

C++ mods must be rebuilt to work on 3.0.1.

Current known issues & solutions:

1. If you have the GUI console enabled and visible, and on launch the window is blank/white, go into UE4SS-settings.ini and set GraphicsAPI = dx11.
2. If you're experiencing game crashes on startup, try setting bUseUObjectArrayCache = false in UE4SS-settings.ini.
3. If mods aren't working as expected, make sure you follow their install instructions properly, not based on "what worked before". This is due to UE4SS supporting a number of different mod types and the way they're installed can vary.

Additional couple of notes for mod authors:

1. We have noticed a number of popular mods that have fallen down a pitfall that may very well lead to performance issues. Please refer to this section in the docs for more information.
2. If you're developing on the latest experimental version, please make sure to use the docs.ue4ss.com/dev version of the docs as this is updated with the latest changes.

-UE4SS team

New

General

Added new docs pages for devlogs, C++ examples, C++ BP macros (UE4SS #355) - Buckminsterfullerene

Added examplanation of 'ai' to the Object Dumper doc page (UE4SS #349)

Live View

UHT Dumper

Lua API

C++ API

Experimental

Changes

General

Update docs installation guide for 3.0.0 (UE4SS #355) - Buckminsterfullerene

Added step to C++ prerequisits to join Epic Games org for repo access (UE4SS #339) - groffta

Updated Lua doc for RegisterHook to accurately state how the callback params work (UE4SS #372)

Clarify Lua metamethod usage for some classes (UE4SS #376) - Lyrth

Live View

UHT Dumper

Lua API

Fixed bug where RegisterHook on native functions couldn't affect return values unless you had both a pre and a post hook (UE4SS #366)

C++ API

Repo & Build Process

Removed custom game configs for games that don't need them anymore (UE4SS #386) - Buckminsterfullerene

Added mods directory zip as an explicit step to the bug report template (UE4SS #358)

Added PR template (UE4SS #363) - Buckminsterfullerene

Fixes

General

Fixed "FindAllOf" dereferencing a nullptr (UEPsuedo #78) - localcc

Fixed a memory leak when BPMacros.hpp was used (UEPsuedo #75)

Fixed modifier key issue causing keybinds to not work (UE4SS #389) - Tangerie

Live View

Fix GUI crash when clicking close window button (UE4SS #337) - localcc

UHT Dumper

Lua API

Fix Lua FString setter (UE4SS #325) - Yangff

Fix FindObject and Mod:SetSharedVariable userdata type matching (UE4SS #342) - Lyrth

Fixed non-native UFunctions hooks not working if hooked by multiple mods (UE4SS #351)

C++ API

Fix TProperty cpp mods linking issue (UEPsuedo #77) - localcc

Settings

Added

Removed

v3.0.0

After 9 months in development, we hope 3.0 was worth the wait. We want future releases to be more frequent, as constantly telling people "try latest experimental" is never a good solution.

For the next release, we have some exciting new features in development, so stay tuned for those. We're very excited to reveal what we've been working on soon, but we really needed to get 3.0 out first.

-UE4SS team

Installation over 2.5.2

Remember to check the README for the latest installation instructions.

Since the UE4SS-settings.ini has changed in this release, you should use the new one, so if you have made settings changes, remember to back them up!

When installing 3.0 in the place of the previous release 2.5.2, you must replace all existing UE4SS files with new files, except for the UE4SS_Signatures folder if your game is using custom sigs.

3.0 also uses two new dlls:

• UE4SS.dll
• dwmapi.dll

and no longer uses the older xinput1_3.dll, so please also delete xinput1_3.dll if you have one.

New

General

Added support for UE Version 5.2 and 5.3 games

New proxy DLL loading system. - LocalCC
Different proxy DLLs can now easily be compiled for cases where xinput1_3 cannot be used for any reason.
Alternative proxys may be compiled by specifying -DUE4SS_PROXY_PATH=/Path/To/DLL.dll when running the CMake command.

Replace built-in address scans with patternsleuth which should greatly improve accuracy and reduce need for manual AOB configuration - trumank, LongerWarrior

Added SuperStruct, sps, to Struct and ScriptStruct entries in the object dumper

Live View

Can now view enum values in the Live View debugger

Added ClassFlags to UClass and derivatives

Added a checkbox that toggles search options globally, meaning when not searching

Added search filter Function parameter flags, it excludes objects that are non-UFunctions and UFunctions that don't have params with the specified flags

Added search filter Non-instances only

Added search filter Include CDOs, it includes objects that are not a ClassDefaultObject or an ArchetypeObject

Added search filter CDOs only, it excludes objects that are not a ClassDefaultObject or an ArchetypeObject

Added search filter Use Regex for search - HW12Dev

Added search filter Exclude class name, it excludes objects with a ClassPrivate name not containing the specified (case-sensitive) string

Added search filter Has property, it exclude objects that don't have a property (inheritance included) of the specified (case-sensitive) name

Added search filter Has property of type, it excludes objects that don't have a property (inheritance included) of the specified (case-sensitive) type

UHT Dumper

Removed unnecessary explicit _MAX elements from enums

Made FWeakObjectPtr overridable unless used in a TArray or TMap

Lua API

Added an optional third parameter to RegisterHook
If provided, it will act as a post callback hook where out-params can be modified
Note that for BP-only functions, both callbacks act as post callbacks
If the hooked function has a return value, the second param to the post callback will be the return value

Out-params for script hooks (RegisterCustomEvent or RegisterHook on a BP-only UFunction) can now be set by doing Param:set(<new-value>)

Added the function Empty to TArray

Added RegisterLoadMapPreHook/RegisterLoadMapPostHook hooks for UEngine::LoadMap.

C++ API

Finalize C++ API. - LocalCC; Truman

Removed need for "cppsdk" when linking C++ mods. This is due to the new proxy system. - LocalCC
Due to the above change, C++ mods now only need to link to UE4SS.

C++ mods are now loaded earlier, and will keep the game from starting until all mods have finished executing their start_mod function

Made calls to UObject::StaticClass work for custom UObject classes that have been made with the DECLARE_EXTERNAL_OBJECT_CLASS and IMPLEMENT_EXTERNAL_OBJECT_CLASS macros

Expose IMGui to C++ mods - Truman

Added on_lua_start for C++ mods.
Overload #1: This function fires whenever any Lua mod is started.
Overload #2: This function fires whenever a Lua mod by the same name as the C++ mod is started.
It allows interactions with Lua from C++ mods.

Added on_lua_stop for C++ mods.
Overload #1: This function fires whenever any Lua mod is about to be stopped.
Overload #2: This function fires right before a Lua mod by the same name as the C++ mod is about to be stopped.

Added UFunction::RegisterPreHookForInstance and UFunction::RegisterPostHookForInstance
These functions work the same as UFunction::RegisterPreHook/UFunction::RegisterPostHook except the callback is only fired if the context matches the specified instance
These new functions need to be handled with care as they can cause crashes if you don't validate that the instance you're passing during registration is valid inside the callback

Added overloads for UObject::GetFunctionByName and UObject::GetFunctionByNameInChain that take an FName instead of a string

Added UEnum::NumEnums, which returns the number of enum values for the enum

Added UEnum::GenerateEnumPrefix, which is the same as https://docs.unrealengine.com/5.2/en-US/API/Runtime/CoreUObject/UObject/UEnum/GenerateEnumPrefix/

Added UGameplayStatics::FindNearestActor

Added the following functions to AActor: K2_DestroyActor, K2_SetActorLocation, K2_SetActorLocationAndRotation, K2_GetActorRotation, K2_SetActorRotation, GetActorScale3D, SetActorScale3D, GetActorEnableCollision, SetActorEnableCollision, SetActorHiddenInGame, IsActorTickEnabled, SetActorTickEnabled, GetActorTickInterval, SetActorTickInterval, GetActorTimeDilation - Okaetsu

Experimental

Added ExperimentalFeatures section to UE4SS-settings.ini. All experimental features will default to being turned off. To use referenced features, change the relevant config setting to = 1

Added ability to call UFunctions from Live View GUI

Changes

General

The shortcut (CTRL + O) for opening the GUI is now a toggle, meaning it can also be used for closing the GUI

The shortcut (previously J) for dumping objects (generating UE4SS_ObjectDump.txt) has been changed to CTRL + J

The shortcut (previously D) for generating CXX headers has been changed to CTRL + H

Change AOB Sig Scanner backend to use std::find for major performance increase - inspired by Truman

Scan for specified time rather than number of attempts due to speed increase

Improved performance for U/FProperty lookups

Improved performance for UFunction lookups

Improved performance of the GUI log, it's now O(n) - trumank

BPModLoaderMod: Add ability to specify load order - Okaetsu

Add additional extensions to USMap dumper - Atenfyr; Archengius

Fix bug in USMap dumper with enums with 256 entries - Atenfyr

Live View

UHT Dumper

Lua API

Improved reliability of IsValid

C++ API

The callbacks for all hook registration functions inside the Unreal::Hook namespace can now take lambdas that capture variables

Changed many functions to use coroutines - LocalCC
This means the syntax for those functions is now identical to a range-based for loop instead of a function taking a callback

Repo & Build Process

Add automated release script - Truman

Change documentation build process; the docs will now have a dev version (at /dev) for changes on main branch and a current version (at normal root) for the state of the docs at the current release - Truman; Buckminsterfullerene

Removed libfmt dependency

Gradual work on getting Clang to work - LocalCC; Narknon

Fixes

General

Finish adding version 4.11 support

Fix case preserving names switch - LocalCC

Live View

Fixed two crashes occurring when exploring structs nested in arrays or other structs

UHT Dumper

Fixed enums inappropriately using uint8

Lua API

Fixed UnregisterHook

Fixed FText:ToString - LocalCC

Improved stability when using hooks or ExecuteInGameThread

TArrays are now resized when being indexed into if necessary

C++ API

Fixed FText constructor implementation via optional AOB - LocalCC

Fixed initialization functions not being correctly called when a mod is restarted - LocalCC

Fixed C++ mods not loading if a Lua mod with the same name is present

Settings

Added:

; Whether the cache system for AOBs will be used.
; Default: 1
UseCache = 1

; The number of seconds the scanner will scan for before giving up
; Default: 30
SecondsToScanBeforeGivingUp = 30

[ExperimentalFeatures]
GUIUFunctionCaller = 1

Removed:

; The maximum number attempts the scanner will try before erroring out if an aob isn't found
; Default: 60
MaxScanAttemptsNormal = 60

; The maximum number attempts the scanner will try for modular games before erroring out if an aob isn't found
; Default: 2000
MaxScanAttemptsModular = 2500

RE-UE4SS 2.5.2

Changelog

Note: This is a stopgap release to add Jedi Survivor support, and the below changelog is partially incomplete. Full changelog will be posted when version 2.6 is released.

Fixes

Fix more detached submodules (including Lua 5.4.4 update)
Expose certain additional classes to the member variable and vtable configs.

New

Add USMAP dumper extensions (Atenfyr)
Add Lua Type generator for use by a Lua language server (TrumanK). See https://marketplace.visualstudio.com/items?itemName=sumneko.lua and https://github.com/LuaLS/lua-language-server/wiki/Annotations
Font scaling setting for Live View

Live View

Add "PlayerControlled" to liveview tab

Lua

Add IsValid() to TArray
Fixed UnregisterHook
Expanded RegisterHook to work on BP functions where it previously only worked on native functions
Added UnregisterCustomEvent
Fixed bug that could cause hooked functions to not process the return value properly
Lua_lock implementation/threading fixes (ParcelRot)

UHT Dumper

Remove predeclarations in .cpp files

QoL

Add font scaling setting to live view GUI

Experimental

C++ Modding API (LocalCC + UE4SS) - Recommended to wait until 2.6 release to begin use.

RE-UE4SS 2.5.1

v2.5.1 Changelog

Fix detached submodules

v2.5.0 Changelog

New Features

Blueprint ModLoading

Added blueprint mod loading/actor spawning mod.
To enable, set BPModLoaderMod : 1 in Mods/mods.txt.
Blueprint mods go in /Game/Content/Paks/LogicMods

Creating BP mods is the same as using UML, a tutorial can be found here: https://www.youtube.com/watch?v=fB3yT85XhVA

Added creating LogicMods folder automatically.

Thank you to RussellJ for permission to implement this.

Lua

Update to Lua 5.4.4
Added support for UInterface.
Added several global lua functions, including 'IterateGameDirectories'. See API.txt for full details.
Added additional hooks and functions to Lua. See full list in API.txt. Note in particular:
- UnregisterHook (unregister a previously hooked function using the ids returned from the hooked function)
- RegisterCustomEvent (allows hooking of custom BP functions/events through ProcessInternal)
Non-struct out parameters now partially work. You need to create and pass a Lua table wherever there's an out-param. The value inside the table doesn't matter and is not passed to the UFunction. The table will have a field with the same name as the out-param which will contain the value.

Lua Mods:
Update to linetrace mod to use helpers

Live View

Added filtering by Inheritance or Instances only when searching in the live view. Accessed by right clicking in the search bar.

TMap Override Dumper

Dumps TMap overrides for UAssetAPI/GUI and FModel serialization of assets. This is a json file that gets input in the relevant program to allow it to parse TMaps with untyped structs as a key or value.

Changes

Live View

The live view array now uses a lower default number of objects per visual chunk (note that the objects are no longer 1 to 1 with the true UE "Chunks" in the array).
The default number of objects per chunk can be edited in the settings.
Added UHT Dumper and CXX Generator buttons to Dumpers tab.
Add timestamp to static mesh and actor dump file names.

Lua

FName global function now has an optional second param.

Fixes

CXX Gen

Generator will continue in certain events where it would previously crash.

UHT Generator

Generator will make a missed property comment in certain events where it would previously crash.
Fixed crash if FunctionSignature was nullptr in the UHT generator.

Lua

Fix mods not being enabled if carriage returns are used in mods.txt (Praydog)
Fixed 'RegisterHook' not working properly if the UFunction has spaces in its name.
Fix typo in Lua cpath causing DLLs to not get found (Praydog)
Added a lock guard for ExecuteInGameThread to prevent a crash.
Fixed 'EFindName' not being exposed to Lua properly.

Live View

Fixed a race condition in live view.
Fixed a crash when expanding an array of objects in live view.

Other

Mod developers and compatibility troubleshooting users may wish to download the DEV- zip. End users should download the normal files.

UE4SS Experimental Release

some notes about most important changes such as:

• changing of default ue4ss install location, overriding and its backwards compatibility
• new build system
• linux port

New

Added support for UE Version 5.4 - (UE4SS #503)
Added basic support for Development/Debug/Test built Unreal Engine games (UE4SS #607)

• To use this functionality, set DebugBuild to true in UE4SS-Settings.ini

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.
BREAKING: - This also changes the default FName alignment from 8 to 4.

• To use this functionality, enter LessEqual421 in the section of the XMake configuration command.

General

UE Platform support, which allows for much easier internal implementation of new Unreal classes (UEPseudo #80) - narknon, localcc

Added new installation method by allowing overriding of the location of the UE4SS.dll, documentation. - (UE4SS #506) - Buckminsterfullerene

Live View

Added search filter: IncludeClassNames. (UE4SS #472) - Buckminsterfullerene

UHT Dumper

Lua API

Added global function CreateInvalidObject, which returns an invalid UObject. (UE4SS #652)
Added GenerateLuaTypes function. (UE4SS #664)
Added global Dumpers functions to Types.lua. (UE4SS #664)

Types.lua PR #650

• Added NAME_None definition
• Added EFindName enum definition
• Added FName function overloads with FindType parameter

UEHelpers PR #650

• 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)
• Added functions: GetEngine, GetGameInstance, GetGameViewportClient, GetGameModeBase, GetGameStateBase,GetPersistentLevel and GetWorldSettings
• Added functions to get static objects: GetKismetStringLibrary, GetKismetTextLibrary
• Added function GetActorFromHitResult which extracts the hit actor from a FHitResult struct based on UE's version
• Added FName utility functions:
  • FindFName: wrapper for FName(Name, EFindName.FNAME_Find)
  • AddFName: wrapper for FName(Name, EFindName.FNAME_Add)
• Added Lua Server Annotations to all UEHelpers functions

C++ API

Key binds created with UE4SSProgram::register_keydown_event end up being duplicated upon mod hot-reload.
To fix this, CppUserModBase::register_keydown_event has been introduced.
It's used exactly the same way except without the UE4SSProgram:: part. (UE4SS #446)

Added on_ui_init(), it fires when the UI is initialized.
It's intended to use the UE4SS_ENABLE_IMGUI macro in this function.
Failing to do so will cause a crash when you try to render something with imgui.

BREAKING: Changed FTransform constructor to be identical to unreal.

Added OpenFor::ReadWrite, to be used when calling File::open.
This can be used when calling FileHandle::memory_map, unlike OpenFor::Writing. (UE4SS #507)

BPModLoader

Experimental

Changes

General

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) - Buckminsterfullerene
Updated PatternSleuth submodule (UE4SS #638)

Live View

Fixed the majority of the lag (UE4SS #512)

Added support for watching ArrayProperty and StructProperty (UE4SS #419)

The search filter ExcludeClassName can now be found in the IncludeClassNames dropdown list. (UE4SS #472) - Buckminsterfullerene

The following search filters now allow multiple values, with each value separated by a comma: IncludeClassNames, ExcludeClassNames, HasProperty, HasPropertyType. (UE4SS #472) - Buckminsterfullerene

UHT Dumper

Lua API

print now behaves like vanilla Lua (can now accept zero, one, or multiple arguments of any type) (UE4SS #423) - Lyrth

The callback of NotifyOnNewObject can now optionally return true to unregister itself (UE4SS #432) - Lyrth

RegisterConsoleCommandHandler, RegisterConsoleCommandGlobalHandler, RegisterProcessConsoleExecPreHook and RegisterProcessConsoleExecPostHook now support enclosing parameters in double quotes ("). This allows spaces within the quotes to be ignored, treating the enclosed string as a single parameter. (UE4SS #653, UE4SS #669)

BREAKING: RegisterProcessConsoleExecPreHook, RegisterProcessConsoleExecPostHook callback parameter CommandParts now includes the command name at the start of the array (lua array index 1). (UE4SS #669)

UEHelpers UE4SS #650

• Increased version to 3
• Reworked all UEHelpers functions to ensure that they always return an object which can be checked with the function IsValid for validation
• 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)
• Reworked UEHelpers.GetWorld function to use UWorld cache (UWorld usually never changes)
• Change UEHelpers.GetWorldContextObject function annotation to return UObject. (Any UObject with a GetWorld() function is a valid WorldContext)
• Removed duplicate function UEHelpers.GetKismetMathLibrary

C++ API

BPModLoader

BPModLoader now supports loading mods from subdirectories within the LogicMods folder (UE4SS #412) - Ethan Green

Repo & Build Process

Switch to xmake from cmake which makes building much more streamlined (UE4SS #377, UEPseudo #81) - localcc

Fixes

General

Fixed BPModLoaderMod not working in games made in UE 5.2+ - (UE4SS #503)

Fixed adding elements to TArray in Lua incorrectly resizing and zeroing out previous values (UE4SS #436) - dnchattan

Fixed some debug GUI layout alignments, especially with different GUI font scaling settings (UE4SS #429) - Lyrth

Fixed PalServer not accepting connections from players (UE4SS #453)

Fixed a crash that would occur randomly due to accidental execution of Live View search code (UE4SS #475)

Fixed freeze related to the error "Tried to execute UFunction::FuncPtr hook but there was no function map entry" (UE4SS #468)

Fixed ModsFolderPath in UE4SS-settings.ini not working (UE4SS #609)

Live View

Fixed the "Write to file" checkbox not working for functions in the Watches tab (UE4SS #419)

Reduced the likelihood of a crash happening on shutdown when at least one watch is enabled (UE4SS #419)

Fixed constantly searching even if the search field is empty, and even if not on the tab (UE4SS #475)

UHT Dumper

Fix SetupAttachment implementations randomly changing order (UE4SS #606) - Buckminsterfullerene

Lua API

Fixed FString use after free (UE4SS #425) - localcc

Fixed the "IterateGameDirectories" global function throwing "bad conversion" errors (UE4SS #398)

Fixed FText not working as a parameter (in RegisterHook, etc.) (UE4SS #422) - localcc

Fixed crash when calling UFunctions that take one or more 'out' params of type TArray. (UE4SS #477)

Fixed RegisterProcessConsoleExecPostHook. (UE4SS #631)

Fixed FindFirstOf return type annotation in Types.lua to signal that the return value will never be nil. (UE4SS #652)

C++ API

Fixed a crash caused by a race condition enabled by C++ mods using UE4SS_ENABLE_IMGUI in their constructor (UE4SS #481)

Fixed the std::span returned by FileHandle::memory_map being improperly sized. (UE4SS #507)

Fixed...

RE-UE4SS 2.3.1 Hotfix

Adds missed commit related to UHT gen ordering. See v2.3.0 release for full changelog.

RE-UE4SS 2.3.0 Release

New

Lua

• Added 'ModRef.SetSharedVariable' and 'ModRef.GetSharedVariable'

• Added UObject.HasAnyInternalFlags

• Added global table: 'EInternalObjectFlags'

• You can now set an ObjectProperty value to nil. Previously such an action would be ignored

• When calling 'IsValid()' on UObjects, whether the UObject is reachable is now taken into account

• The splitscreen mod now operates independently of the Lua state which means that hot-reloading shouldn't cause it to break

• Added shared module "UEHelpers" to provide shortcut functions to the Lua module for commonly used UE functions or classes

Live View GUI

• Default renderer of the GUI has been changed to OpenGL for compatibility reasons. This can be changed back to dx11 by editing the setting in UE4SS-settings.ini to "dx11"

Changes

UHT Generation

• Buckminsterfullerene - Includes and forward declarations are now ordered to allow for easier diffing
• Buckminsterfullerene - Added setting to force "Config = Engine" on UCLASS specifiers for classes with "DefaultConfig", "GlobalUserConfig" or "ProjectUserConfig"

CXX Dump

• Buckminsterfullerene - Structs and classes are now ordered to allow for easier diffing

Fixes

UHT Generation

• Praydog - Fixes to build.cs generation
• Buckminsterfullerene - Tick functions now include the required template

RE-UE4SS 2.2.1 Hotfix

Fixes:

UHT Generation

• Fixes bug introduced in 2.2.0 that caused certain modules not to be included in the build.cs files

RE-UE4SS 2.2.0

New

Live View Debugger

• Add live editing of properties. May be unstable with certain structs. Please report crashes with an Issue.

Keybinds

• The old lua mods that only registered a key bind (ObjectDumperMod, UHTCompatibleHeaderGeneratorMod, & CXXHeaderGeneratorMod) have been removed.
• If you have an old mod installed, it takes precedence over the new mod.
• The new mod will have all keybinds listed at the top of the file to make it easy to see which key binds are already in use.
• Added keybinds for the USMAP (CTRL + NUM_SIX), All Actor (CTRL + NUM_SEVEN) and Static Mesh (CTRL + NUM_EIGHT) dumpers.

Lua

• Add mod - LineTraceMod - Prints name of object in center of camera to console. Not enabled by default.
• Add mod - SplitScreenMod attempts to spawn additional player characters in splitscreen mode. Edit the main.lua script to change how the first controller functions. Not enabled by default.
• New ExecuteInGameThread function for improved compatibility with certain internal UE functions

Fixes

UHT Generation

• Praydog - Fixed certain possible crashes with UHT Generation
• Praydog - Fixed UHT Generation crashing on building stubs when Engine module dumping is enabled
• Allow Instanced specifier on Map properties where the value is a UObject base
• Add GetTypeHash inline function generation for structs used in Map properties

General

• Praydog - StaticConstructObject: Fix crash when Params.Class is nullptr

Known Issues

• Certain structs will cause crashes when live editing
• You must edit certain structs from the highest level rather than from the tree view (editing within the tree view is disabled currently).

RE-UE4SS 2.1.1 Hotfix

Fixes

• Fixed Hot Reload for Lua Scripting
• Fixed UE 5.1 compatibility