Merge pull request #1136 from Novaenia/struct_property_lua

feat: support for registered properties in UScriptStruct ⇔ Lua conversion

Author: narknon

UE4SS/include/LuaType/LuaCustomProperty.hpp

@@ -3,6 +3,7 @@
 #include <memory>
 #include <string>
 #include <vector>
+#include <functional>
 
 #include <String/StringType.hpp>
 
@@ -34,6 +35,10 @@ namespace RC::LuaType
           public:
             auto add(StringType property_name, std::unique_ptr<Unreal::CustomProperty>) -> void;
             auto clear() -> void;
+
+            using ForEachCallable = std::function<bool(LuaCustomProperty const&)>;
+            auto for_each(Unreal::UObject* base, const ForEachCallable& callable) -> bool;
+
             auto find_or_nullptr(Unreal::UObject* base, StringType property_name) -> Unreal::FProperty*;
         };
 

UE4SS/src/LuaType/LuaCustomProperty.cpp

@@ -26,7 +26,7 @@ namespace RC::LuaType
         properties.clear();
     }
 
-    auto LuaCustomProperty::PropertyList::find_or_nullptr(Unreal::UObject* base, StringType property_name) -> Unreal::FProperty*
+    auto LuaCustomProperty::PropertyList::for_each(Unreal::UObject* base, const ForEachCallable& callable) -> bool
     {
         Unreal::FProperty* custom_property_found{};
 
@@ -66,14 +66,28 @@ namespace RC::LuaType
                 }
             }
 
-            if (class_matches && property_name == property_item.m_name)
+            if (class_matches && !callable(property_item))
             {
-                // Compare name here
-                custom_property_found = property_item.m_property.get();
-                break;
+                return false;
             }
         }
 
+        return true;
+    }
+
+    auto LuaCustomProperty::PropertyList::find_or_nullptr(Unreal::UObject* base, StringType property_name) -> Unreal::FProperty*
+    {
+        Unreal::FProperty* custom_property_found{};
+
+        for_each(base, [&](LuaCustomProperty const& property) {
+            bool match = property.m_name == property_name;
+            if (match)
+            {
+                custom_property_found = property.m_property.get();
+            }
+            return !match;
+        });
+
         return custom_property_found;
     }
 } // namespace RC::LuaType

UE4SS/src/LuaType/LuaUObject.cpp

@@ -32,6 +32,7 @@
 #include <Unreal/UInterface.hpp>
 #include <Unreal/World.hpp>
 #include <Unreal/Engine/UDataTable.hpp>
+#include <UnrealCustom/CustomProperty.hpp>
 
 #pragma warning(default : 4005)
 #include <DynamicOutput/DynamicOutput.hpp>
@@ -538,10 +539,8 @@ namespace RC::LuaType
             return;
         }
 
-        for (Unreal::FProperty* field : Unreal::TFieldRange<Unreal::FProperty>(script_struct, Unreal::EFieldIterationFlags::IncludeSuper | Unreal::EFieldIterationFlags::IncludeDeprecated))
-        {
+        auto handle_property = [&](Unreal::FProperty* field, const std::string& field_name) {
             Unreal::FName field_type_fname = field->GetClass().GetFName();
-            const std::string field_name = to_utf8_string(field->GetName());
 
             // Push the field name (key for the table)
             lua_pushstring(lua.get_lua_state(), field_name.c_str());
@@ -550,7 +549,7 @@ namespace RC::LuaType
             // For lua_rawget, we need the actual stack position of the table
             // If table_index is positive, it stays the same even after pushing the key
             // If it's negative, we need to adjust for the key we just pushed
-            
+
             // Adjust index for negative values after pushing key
             int adjusted_index = table_index;
             if (table_index < 0)
@@ -564,7 +563,7 @@ namespace RC::LuaType
             if (table_value_type == LUA_TNIL || table_value_type == LUA_TNONE)
             {
                 lua.discard_value(-1);
-                continue;
+                return;
             }
 
             int32_t name_comparison_index = field_type_fname.GetComparisonIndex();
@@ -595,6 +594,16 @@ namespace RC::LuaType
                         );
 
             }
+        };
+
+        LuaCustomProperty::StaticStorage::property_list.for_each(script_struct, [&](LuaCustomProperty const& lua_property) {
+            handle_property(lua_property.m_property.get(), to_utf8_string(lua_property.m_name));
+            return true;
+        });
+
+        for (Unreal::FProperty* field : Unreal::TFieldRange<Unreal::FProperty>(script_struct, Unreal::EFieldIterationFlags::IncludeSuper | Unreal::EFieldIterationFlags::IncludeDeprecated))
+        {
+            handle_property(field, to_utf8_string(field->GetName()));
         }
     }
 
@@ -620,13 +629,9 @@ namespace RC::LuaType
             return;
         }
 
-        LuaMadeSimple::Lua::Table lua_table = create_new_table
-                                                  ? lua.prepare_new_table()
-                                                  : lua.get_table();
+        LuaMadeSimple::Lua::Table lua_table = create_new_table ? lua.prepare_new_table() : lua.get_table();
 
-        for (Unreal::FProperty* field : Unreal::TFieldRange<Unreal::FProperty>(script_struct, Unreal::EFieldIterationFlags::IncludeSuper | Unreal::EFieldIterationFlags::IncludeDeprecated))
-        {
-            std::string field_name = to_utf8_string(field->GetName());
+        auto handle_property = [&](Unreal::FProperty* field, const std::string& field_name) {
             Unreal::FName field_type_fname = field->GetClass().GetFName();
             int32_t name_comparison_index = field_type_fname.GetComparisonIndex();
 
@@ -684,6 +689,16 @@ namespace RC::LuaType
                         field_type_fname.ToString()
                         );
             }
+        };
+
+        LuaCustomProperty::StaticStorage::property_list.for_each(script_struct, [&](LuaCustomProperty const& lua_property) {
+            handle_property(lua_property.m_property.get(), to_utf8_string(lua_property.m_name));
+            return true;
+        });
+
+        for (Unreal::FProperty* field : Unreal::TFieldRange<Unreal::FProperty>(script_struct, Unreal::EFieldIterationFlags::IncludeSuper | Unreal::EFieldIterationFlags::IncludeDeprecated))
+        {
+            handle_property(field, to_utf8_string(field->GetName()));
         }
 
         lua_table.make_local();