refactor: Rename function CreateBlankObject to CreateInvalidObject

UE4SS-RE · Sep 30, 2024 · 5f96538 · 5f96538
1 parent 55479d5
commit 5f96538
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 8 deletions.
diff --git a/UE4SS/src/Mod/LuaMod.cpp b/UE4SS/src/Mod/LuaMod.cpp
@@ -839,7 +839,7 @@ namespace RC
     {
         lua.register_function("print", LuaLibrary::global_print);
 
-        lua.register_function("CreateBlankObject", [](const LuaMadeSimple::Lua& lua) -> int {
+        lua.register_function("CreateInvalidObject", [](const LuaMadeSimple::Lua& lua) -> int {
             LuaType::auto_construct_object(lua, nullptr);
             return 1;
         });

diff --git a/assets/Changelog.md b/assets/Changelog.md
@@ -21,7 +21,7 @@ Added search filter: `IncludeClassNames`. ([UE4SS #472](https://github.com/UE4SS
 ### UHT Dumper
 
 ### Lua API
-Added global function `CreateBlankObject`, which returns an invalid UObject. ([UE4SS #652](https://github.com/UE4SS-RE/RE-UE4SS/issues/652)) 
+Added global function `CreateInvalidObject`, which returns an invalid UObject. ([UE4SS #652](https://github.com/UE4SS-RE/RE-UE4SS/issues/652)) 
 
 ### C++ API
 Key binds created with `UE4SSProgram::register_keydown_event` end up being duplicated upon mod hot-reload.  

diff --git a/assets/Mods/shared/Types.lua b/assets/Mods/shared/Types.lua
@@ -282,7 +282,7 @@ EInternalObjectFlags = {
 
 ---Creates an blank UObject whose IsValid function always returns false
 ---@return UObject
-function CreateBlankObject() end
+function CreateInvalidObject() end
 
 ---@param ObjectName string
 ---@return UObject

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -54,7 +54,7 @@
     - [FWeakObjectPtr](./lua-api/classes/fweakobjectptr.md)
   - [Global Functions]()
     - [print](./lua-api/global-functions/print.md)
-    - [CreateBlankObject](./lua-api/global-functions/createblankobject.md)
+    - [CreateInvalidObject](./lua-api/global-functions/createinvalidobject.md)
     - [FName](./lua-api/global-functions/fname.md)
     - [FText](./lua-api/global-functions/ftext.md)
     - [IterateGameDirectories](./lua-api/global-functions/iterategamedirectories.md)

diff --git a/docs/lua-api.md b/docs/lua-api.md
@@ -110,7 +110,8 @@ This is an overall list of API definitions available in UE4SS. For more readable
     print(any... Message)
         - Does not have the capability to format. Use 'string.format' if you require formatting.
     
-    CreateBlankObject() -> UObject
+    CreateInvalidObject() -> UObject
+        - Creates an object with an IsValid function that always returns false
 
     StaticFindObject(string ObjectName) -> { UObject | AActor | nil }
     StaticFindObject(UClass Class=nil, UObject InOuter=nil, string ObjectName, bool ExactClass=false)

diff --git a/...api/global-functions/createblankobject.md → ...i/global-functions/createinvalidobject.md b/...api/global-functions/createblankobject.md → ...i/global-functions/createinvalidobject.md
@@ -1,13 +1,13 @@
-# CreateBlankObject
+# CreateInvalidObject
 
-The function `CreateBlankObject` always returns an object with an `IsValid` function that returns `flase`.
+The function `CreateInvalidObject` always returns an object with an `IsValid` function that returns `flase`.
 
 The sole purpose of the function is to ensure that the mod's Lua code adheres to UE4SS code conventions, where all functions return an invalid `UObject` instead of `nil`.
 
 ## Example
 The example code below ensures that you never need to check if `EngineCache` is `nil`, and the same applies to the return value of `GetEngine()`.
 ```lua
-local EngineCache = CreateBlankObject() ---@cast EngineCache UEngine
+local EngineCache = CreateInvalidObject() ---@cast EngineCache UEngine
 ---Returns instance of UEngine
 ---@return UEngine
 function GetEngine()