Merge branch 'praydog:master' into master

Author: joeyhodge

include/reframework/API.h

@@ -7,7 +7,7 @@
 #endif
 
 #define REFRAMEWORK_PLUGIN_VERSION_MAJOR 1
-#define REFRAMEWORK_PLUGIN_VERSION_MINOR 13
+#define REFRAMEWORK_PLUGIN_VERSION_MINOR 14
 #define REFRAMEWORK_PLUGIN_VERSION_PATCH 0
 
 #define REFRAMEWORK_RENDERER_D3D11 0
@@ -34,6 +34,7 @@ typedef void (*REFOnPreApplicationEntryCb)();
 typedef void (*REFOnPostApplicationEntryCb)();
 typedef void (*REFOnDeviceResetCb)();
 typedef bool (*REFOnMessageCb)(void*, unsigned int, unsigned long long, long long);
+typedef bool (*REFOnPreGuiDrawElementCb)(void*, void*);
 
 typedef struct {
     void* context;
@@ -59,6 +60,7 @@ typedef bool (*REFOnMessageFn)(REFOnMessageCb);
 
 typedef bool (*REFOnImGuiFrameFn)(REFOnImGuiFrameCb);
 typedef bool (*REFOnImGuiDrawUIFn)(REFOnImGuiDrawUICb);
+typedef bool (*REFOnPreGuiDrawElementFn)(REFOnPreGuiDrawElementCb);
 
 typedef struct {
     int major;
@@ -88,6 +90,7 @@ typedef struct {
 
     REFOnImGuiFrameFn on_imgui_frame;
     REFOnImGuiDrawUIFn on_imgui_draw_ui;
+    REFOnPreGuiDrawElementFn on_pre_gui_draw_element;
 } REFrameworkPluginFunctions;
 
 typedef struct {

src/mods/APIProxy.cpp

@@ -93,6 +93,13 @@ bool APIProxy::add_on_imgui_draw_ui(REFOnImGuiDrawUICb cb) {
     return true;
 }
 
+bool APIProxy::add_on_pre_gui_draw_element(REFOnPreGuiDrawElementCb cb) {
+    std::unique_lock _{m_api_cb_mtx};
+
+    m_on_pre_gui_draw_element_cbs.push_back(cb);
+    return true;
+}
+
 void APIProxy::on_lua_state_created(sol::state& state) {
     std::shared_lock _{m_api_cb_mtx};
 
@@ -277,4 +284,23 @@ bool APIProxy::on_message(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam) {
     }
 
     return true;
+}
+
+bool APIProxy::on_pre_gui_draw_element(REComponent* gui_element, void* primitive_context) {
+    std::shared_lock _{m_api_cb_mtx};
+
+    bool any_false = false;
+
+    for (auto&& cb : m_on_pre_gui_draw_element_cbs) {
+        try {
+            if (!cb(gui_element, primitive_context)) {
+                any_false = true;
+            }
+        } catch(...) {
+            spdlog::error("[APIProxy] Exception occurred in on_pre_gui_draw_element callback; one of the plugins has an error.");
+            continue;
+        }
+    }
+
+    return !any_false;
 }

src/mods/APIProxy.hpp

@@ -22,6 +22,7 @@ class APIProxy : public Mod {
     void on_pre_application_entry(void* entry, const char* name, size_t hash) override;
     void on_application_entry(void* entry, const char* name, size_t hash) override;
     void on_device_reset() override;
+    bool on_pre_gui_draw_element(REComponent* gui_element, void* primitive_context) override;
     bool on_message(HWND wnd, UINT message, WPARAM w_param, LPARAM l_param) override;
 
 public:
@@ -34,6 +35,7 @@ class APIProxy : public Mod {
     using REFOnMessageCb = std::function<std::remove_pointer<::REFOnMessageCb>::type>;
     using REFOnImGuiFrameCb = std::function<std::remove_pointer<::REFOnImGuiFrameCb>::type>;
     using REFOnImGuiDrawUICb = std::function<std::remove_pointer<::REFOnImGuiDrawUICb>::type>;
+    using REFOnPreGuiDrawElementCb = std::function<std::remove_pointer<::REFOnPreGuiDrawElementCb>::type>;
 
     bool add_on_lua_state_created(REFLuaStateCreatedCb cb);
     bool add_on_lua_state_destroyed(REFLuaStateDestroyedCb cb);
@@ -44,6 +46,7 @@ class APIProxy : public Mod {
     bool add_on_message(REFOnMessageCb cb);
     bool add_on_imgui_frame(REFOnImGuiFrameCb cb);
     bool add_on_imgui_draw_ui(REFOnImGuiDrawUICb cb);
+    bool add_on_pre_gui_draw_element(REFOnPreGuiDrawElementCb cb);
 
 private:
     // API Callbacks
@@ -55,6 +58,7 @@ class APIProxy : public Mod {
     std::vector<APIProxy::REFOnMessageCb> m_on_message_cbs{};
     std::vector<APIProxy::REFOnImGuiFrameCb> m_on_imgui_frame_cbs{};
     std::vector<APIProxy::REFOnImGuiDrawUICb> m_on_imgui_draw_ui_cbs{};
+    std::vector<APIProxy::REFOnPreGuiDrawElementCb> m_on_pre_gui_draw_element_cbs{};
 
     // Application Entry Callbacks
     std::unordered_map<size_t, std::vector<APIProxy::REFOnPreApplicationEntryCb>> m_on_pre_application_entry_cbs{};

src/mods/PluginLoader.cpp

@@ -72,6 +72,7 @@ REFrameworkPluginFunctions g_plugin_functions {
 
     reframework_on_imgui_frame,
     reframework_on_imgui_draw_ui,
+    reframework_on_pre_gui_draw_element,
 };
 
 REFrameworkSDKFunctions g_sdk_functions {
@@ -932,4 +933,12 @@ bool reframework_on_imgui_draw_ui(REFOnImGuiFrameCb cb) {
     }
 
     return APIProxy::get()->add_on_imgui_draw_ui(cb);
+}
+
+bool reframework_on_pre_gui_draw_element(REFOnPreGuiDrawElementCb cb) {
+    if (cb == nullptr) {
+        return false;
+    }
+
+    return APIProxy::get()->add_on_pre_gui_draw_element(cb);
 }

src/mods/PluginLoader.hpp

@@ -19,6 +19,7 @@ bool reframework_on_device_reset(REFOnDeviceResetCb cb);
 bool reframework_on_message(REFOnMessageCb cb);
 bool reframework_on_imgui_frame(REFOnImGuiFrameCb cb);
 bool reframework_on_imgui_draw_ui(REFOnImGuiDrawUICb cb);
+bool reframework_on_pre_gui_draw_element(REFOnPreGuiDrawElementCb cb);
 
 lua_State* reframework_create_script_state();
 void reframework_destroy_script_state(lua_State*);

src/mods/ScriptRunner.cpp

@@ -135,6 +135,9 @@ ScriptState::ScriptState(const ScriptState::GarbageCollectionData& gc_data,bool
     os["setlocale"] = sol::nil;
     os["getenv"] = sol::nil;
 
+    auto debug = m_lua["debug"];
+    debug["getregistry"] = sol::nil;
+
     bindings::open_sdk(this);
     bindings::open_imgui(this);
     bindings::open_json(this);
@@ -374,6 +377,15 @@ ScriptState::ScriptState(const ScriptState::GarbageCollectionData& gc_data,bool
     );
 
     m_lua["reframework"] = g_framework.get();
+    m_lua.registry()["package_path"] = m_lua["package"]["path"];
+    m_lua.registry()["package_cpath"] = m_lua["package"]["cpath"];
+    m_lua.registry()["package_searchers"] = m_lua.create_table();
+
+    sol::table package_searchers = m_lua["package"]["searchers"];
+
+    for (auto&& [k, v] : package_searchers) {
+        m_lua.registry()["package_searchers"][k] = v;
+    }
 
     // clang-format on
     //callback function removed from constructor and moved out into script runner
@@ -398,7 +410,12 @@ void ScriptState::run_script(const std::string& p) {
 
     spdlog::info("[ScriptState] Running script {}...", p);
 
-    std::string old_path = m_lua["package"]["path"];
+    m_lua["package"]["path"] = m_lua.registry()["package_path"];
+    m_lua["package"]["cpath"] = m_lua.registry()["package_cpath"];
+
+    const std::string old_pristine_path = m_lua.registry()["package_path"];
+    const std::string old_pristine_cpath = m_lua.registry()["package_cpath"];
+    const std::string old_path = m_lua["package"]["path"];
 
     try {
         auto path = std::filesystem::path(p);
@@ -411,6 +428,9 @@ void ScriptState::run_script(const std::string& p) {
         package_path = package_path + ";" + dir.string() + "/?.dll";
 
         m_lua["package"]["path"] = package_path;
+        m_lua.registry()["package_path"] = m_lua["package"]["path"];
+        m_lua.registry()["package_cpath"] = m_lua["package"]["cpath"];
+
         m_lua.safe_script_file(p);
     } catch (const std::exception& e) {
         ScriptRunner::get()->spew_error(e.what());
@@ -421,6 +441,8 @@ void ScriptState::run_script(const std::string& p) {
     }
 
     m_lua["package"]["path"] = old_path;
+    m_lua.registry()["package_path"] = old_pristine_path;
+    m_lua.registry()["package_cpath"] = old_pristine_cpath;
 }
 
 // i have to wonder why this isn't in sol when they have safe_script stuff
@@ -467,6 +489,22 @@ void ScriptState::on_draw_ui() {
     api::imnodes::cleanup();
 }
 
+void ScriptState::on_update_transform(RETransform* transform) {
+    try {
+        if (m_on_update_transform_fns.empty()) {
+            return;
+        }
+        if (m_on_update_transform_fns.find(transform) != m_on_update_transform_fns.end()) {
+            std::scoped_lock _{m_execution_mutex};
+            handle_protected_result(m_on_update_transform_fns[transform](transform));
+        }
+    } catch (const std::exception& e) {
+        ScriptRunner::get()->spew_error(e.what());
+    } catch (...) {
+        ScriptRunner::get()->spew_error("Unknown exception in on_update_transform");
+    }
+}
+
 void ScriptState::on_pre_application_entry(size_t hash) {
     try {
         if (m_pre_application_entry_fns.empty()) {
@@ -613,6 +651,11 @@ void ScriptState::add_vtable(::REManagedObject* obj, sdk::REMethodDefinition* fn
     m_hooks_to_add.emplace_back(obj, fn, pre_cb, post_cb);
 }
 
+void ScriptState::add_update_transform(RETransform* transform, sol::protected_function fn) {
+    ScriptRunner::get()->on_add_update_transform();
+    m_on_update_transform_fns[transform] = fn;
+}
+
 void ScriptState::install_hooks() {
     for (; !m_hooks_to_add.empty(); m_hooks_to_add.pop_front()) {
         auto hookdef = m_hooks_to_add.front();
@@ -1150,6 +1193,26 @@ void ScriptRunner::on_draw_ui() {
     }
 }
 
+void ScriptRunner::on_update_transform(RETransform* transform) {
+    if (!m_has_any_transform_updates) {
+        return;
+    }
+
+    std::scoped_lock _{m_access_mutex};
+
+    if (m_states.empty()) {
+        return;
+    }
+
+    if (m_last_online_match_state) {
+        return;
+    }
+
+    for (auto& state : m_states) {
+        state->on_update_transform(transform);
+    }
+}
+
 void ScriptRunner::on_pre_application_entry(void* entry, const char* name, size_t hash) {
     std::scoped_lock _{ m_access_mutex };
 
@@ -1264,6 +1327,9 @@ void ScriptRunner::reset_scripts() {
     // the FirstPerson mod would attempt to hook an already hooked function
     m_main_state.reset();
     m_states.clear();
+
+    m_has_any_transform_updates = false;
+
     //creating the main lua state
     m_main_state = std::make_shared<ScriptState>(make_gc_data(),true);
     //inserting it into the states vector

src/mods/ScriptRunner.hpp

@@ -137,6 +137,7 @@ class ScriptState : public std::enable_shared_from_this<ScriptState> {
 
     void on_frame();
     void on_draw_ui();
+    void on_update_transform(RETransform* transform);
     void on_pre_application_entry(size_t hash);
     void on_application_entry(size_t hash);
     bool on_pre_gui_draw_element(REComponent* gui_element, void* primitive_context);
@@ -152,6 +153,7 @@ class ScriptState : public std::enable_shared_from_this<ScriptState> {
     // add_hook enqueues the hook definition to be installed the next time install_hooks is called.
     void add_hook(sdk::REMethodDefinition* fn, sol::protected_function pre_cb, sol::protected_function post_cb, sol::object ignore_jmp_obj);
     void add_vtable(::REManagedObject* obj, sdk::REMethodDefinition* fn, sol::protected_function pre_cb, sol::protected_function post_cb);
+    void add_update_transform(RETransform* transform, sol::protected_function fn);
 
     // install_hooks goes through the queue of added hooks and actually creates them. The queue is emptied as a result.
     void install_hooks();
@@ -279,6 +281,8 @@ class ScriptState : public std::enable_shared_from_this<ScriptState> {
     std::unordered_multimap<size_t, sol::protected_function> m_pre_application_entry_fns{};
     std::unordered_multimap<size_t, sol::protected_function> m_application_entry_fns{};
 
+    std::unordered_map<RETransform*, sol::protected_function> m_on_update_transform_fns{};
+
     std::vector<sol::protected_function> m_pre_gui_draw_element_fns{};
     std::vector<sol::protected_function> m_gui_draw_element_fns{};
     std::vector<sol::protected_function> m_on_draw_ui_fns{};
@@ -338,6 +342,7 @@ class ScriptRunner : public Mod {
     }
     void on_frame() override;
     void on_draw_ui() override;
+    void on_update_transform(RETransform* transform) override;
     void on_pre_application_entry(void* entry, const char* name, size_t hash) override;
     void on_application_entry(void* entry, const char* name, size_t hash) override;
     bool on_pre_gui_draw_element(REComponent* gui_element, void* primitive_context) override;
@@ -348,10 +353,6 @@ class ScriptRunner : public Mod {
     const auto& get_state() {
         return m_main_state;
     }
-    //not sure how to approach this, should there be error checking here?
-    const auto& get_state(int index) { 
-        return m_states[index];
-    }
 
     void lock() {
         m_access_mutex.lock();
@@ -389,6 +390,10 @@ class ScriptRunner : public Mod {
         m_states_to_delete.push_back(lua_state);
     }
 
+    void on_add_update_transform() {
+        m_has_any_transform_updates = true;
+    }
+
 private:
     ScriptState::GarbageCollectionData make_gc_data() const {
         ScriptState::GarbageCollectionData data{};
@@ -420,6 +425,7 @@ class ScriptRunner : public Mod {
     std::chrono::system_clock::time_point m_scene_check_time{};
     bool m_checked_scene_once{false};
     bool m_scene_okay{false};
+    bool m_has_any_transform_updates{false};
     bool m_console_spawned{false};
     bool m_needs_first_reset{true};
     bool m_last_online_match_state{false};