Racing UI API #100

Greavesy1899 · 2024-02-27T17:49:32Z

First pass at exposing Racing HUDElement API using RaceXBin.

WIP PR, not going to commit as is. Feedback welcome

Greavesy1899 · 2024-02-27T17:50:08Z

code/client/src/sdk/mafia/database/c_ui_database.h

+                uint8_t padding_1[0x3]; // most likely other 'is visible' flags
+                uint8_t padding_2[0x34A];
+                float m_TargetTime          = 0.0f;
+                uint16_t m_CurCheckpoint    = 0; // maybe


going to figure this out before merge

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h

code/client/src/sdk/ue/game/traffic/c_race_manager.h

code/client/src/core/ui/world_debug.cpp

Segfaultd · 2024-02-27T18:33:06Z

code/client/src/core/ui/world_debug.cpp

+            using namespace SDK::mafia::ui;
+            using namespace SDK::mafia::database;


We should avoid this, it's always better to use the fully-fledged SDK namespace path on mod side

Segfaultd · 2024-02-27T18:33:38Z

code/client/src/sdk/mafia/database/c_ui_database.cpp

+
+namespace SDK {
+    namespace mafia::database {
+        C_UIDatabase::C_HUDTable* C_UIDatabase::GetHUDTable() {


I feel like it can go inside header file and be a const method

Segfaultd · 2024-02-27T18:34:26Z

code/client/src/sdk/mafia/database/c_ui_database.h

+                uint8_t padding_0[0x1E];
+                bool m_RacingVisible = false;
+                uint8_t padding_1[0x3]; // most likely other 'is visible' flags
+                uint8_t padding_2[0x34A];
+                float m_TargetTime          = 0.0f;
+                uint16_t m_CurCheckpoint    = 0; // maybe
+                uint16_t m_TotalCheckpoints = 0; // maybe
+                uint16_t m_CurPosition      = 0;
+                uint16_t m_TotalPositions   = 0;
+                uint32_t m_Unknown          = 0;
+                uint16_t m_CurLap           = 0;
+                uint16_t m_TotalLaps        = 0;
+                uint8_t m_Countdown         = 0;


Overall comment, please use the same member notation style as other SDK files, don't forget to add the offsets on each line and use the padX define style

Segfaultd · 2024-02-27T18:34:55Z

code/client/src/sdk/mafia/database/c_ui_database.h

+            uint8_t padding[0x20];
+            C_HUDTable *m_HUDTable = nullptr;


Padding naming and member notation style

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h

code/client/src/sdk/mafia/ui/hud/race_xbin.cpp

Segfaultd · 2024-02-27T18:36:21Z

code/client/src/sdk/mafia/ui/hud/race_xbin.cpp

+        // need to cast to C_UIDatabase
+        // TODO: Feels like this should be dynamic_cast, rather than reinterpret_cast


Can we handle that comment now? not a big deal

Causes a crash using dynamic_cast, unsure why. I'll debug though.

code/client/src/sdk/mafia/ui/hud/race_xbin.cpp

code/client/src/sdk/ue/game/traffic/c_race_manager.h

Deewarz · 2024-02-27T22:29:49Z

code/client/src/sdk/mafia/ui/c_game_gui_2_module.h

+#include "sdk/ue/sys/sodb/c_database_interface.h"
+#include "sdk/ue/c_weak_ptr.h"


In every SDK files, we have to use relative imports

Could you elaborate?

See #100 (comment)

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h

Deewarz · 2024-03-06T21:01:26Z

code/client/src/sdk/patterns.h

+        // C_RaceTimer
+        uint64_t C_RaceTimer_SetVisible = 0x0;
+        uint64_t C_RaceTimer_StartRace  = 0x0;


Can you put this code in alphabetical order? (I mean between C_Quat and C_SceneObject)

Deewarz · 2024-03-06T21:02:40Z

code/client/src/core/ui/world_debug.cpp

+
+                // VISIBLE
+                ImGui::Text("Racing HUDElement Visibility");
+                ImGui::PushID("Racing_Visible");


Why do you need ID here? (and in other places below)

May have been for a previous revision. They can likely be removed.

Deewarz · 2024-03-06T21:07:46Z

code/client/src/sdk/mafia/database/c_ui_database.cpp

@@ -0,0 +1 @@
+#include "sdk/mafia/database/c_ui_database.h"


I don't think I was clear for here:

If the import is in SDK (code/client/src/sdk/...), you must use relative imports (.../.../)
Elsewhere in the code you must use absolute imports (as you did well in word_debug.cpp)

Here you can use #include "c_ui_database.h"

I much prefer not use use relative imports, in my opinion it polutes the code base and generally causes imports to become unreadable. I'd rather use absolute paths starting with 'sdk'

It's fine in CPP files and the accompanying header file such as c_ui_database.h for c_ui_database.cpp though.

I agree, but there was a discussion about it: #56 (comment)

@Segfaultd ready to reconsider your point of view on this?

If 'sdk' is its own contained module which is expected to transfer between projects, then absolute paths should be okay? As long as the includes remain inside the sdk folder.

We should revise using relative paths and switch to absolute ones; it's still portable as long as you set it to include dirs up in whatever project 'SDK' gets moved into. With relative paths, you introduce some extra friction whenever you need to refactor the source file elsewhere. In general, absolute paths give you a better idea of where the various included files are. In contrast, here it's a sea of ../../../ prefixes that force you to build a mental map of the layout instead.

cc @Segfaultd

Deewarz · 2024-03-06T21:10:04Z

code/client/src/sdk/mafia/database/c_ui_database.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#include "sdk/ue/sys/sodb/c_database_interface.h"


see #100 (comment)

Deewarz · 2024-03-06T21:10:13Z

code/client/src/sdk/mafia/ui/c_game_gui_2_module.h

+#include "sdk/ue/c_variant.h"
+#include "sdk/ue/c_weak_ptr.h"
+#include "sdk/ue/sys/sodb/c_database_interface.h"


see #100 (comment)

Deewarz · 2024-03-06T21:10:20Z

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h

@@ -1,9 +1,44 @@
 #pragma once

+#include "sdk/patterns.h"


see #100 (comment)

Deewarz · 2024-03-06T21:11:26Z

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h

@@ -1,9 +1,44 @@
 #pragma once

+#include "sdk/patterns.h"
+
+#include <utils/hooking/hooking.h>


You probably don't need to re-import hooking here (already imported by pattern.h)

Deewarz · 2024-03-06T21:11:35Z

code/client/src/sdk/mafia/ui/hud/race_xbin.cpp

+#include "sdk/mafia/database/c_ui_database.h"
+#include "sdk/mafia/ui/c_game_gui_2_module.h"


see #100 (comment)

Deewarz · 2024-03-06T21:12:25Z

code/client/src/sdk/patterns.cpp

+        // C_RaceTimer
+        gPatterns.C_RaceTimer_SetVisible = reinterpret_cast<uint64_t>(hook::get_pattern("48 89 5C 24 ? 48 89 6C 24 ? 48 89 74 24 ? 57 41 56 41 57 48 83 EC ? 0F B6 F2"));
+        gPatterns.C_RaceTimer_StartRace = reinterpret_cast<uint64_t>(hook::get_pattern("48 89 5C 24 ? 57 48 83 EC ? 48 8B F9 C7 41 ? ? ? ? ? 41 0F B7 C9"));


Can you put this code in alphabetical order? (I mean between C_Quat and C_SceneObject)

Greavesy1899 · 2024-07-21T08:35:50Z

code/client/src/core/dev_features.cpp

@@ -90,10 +90,13 @@ namespace MafiaMP::Core {
            ToggleVehicleDebug();
        }

+        static bool bTempLockControls = false;


This is all temporary so I can test because ImGui cursor is currently broken. I'll likely remove it out from this PR when it has been approved.

Greavesy1899 added 9 commits January 29, 2024 09:37

Racing: WIP branch for racing game research

c3d40a7

Merge branch 'master' into racing-ui

9a9f12a

Merge branch 'master' into racing-ui

972581b

Merge branch 'master' into racing-ui

b1dfb3d

racing: C_HUDTable; ability to modify UI from cpp

052bd4a

racing: fix header, improve debug UI

7f7c028

Racing: Clean up RaceXBin, implement code in sdk

b7cf2d3

racing: cleanup introduced code

818b2d1

racing: improved debug

427b64d

Greavesy1899 added the enhancement New feature or request label Feb 27, 2024

Greavesy1899 added this to the racing gamemode milestone Feb 27, 2024

Greavesy1899 requested review from Segfaultd and zpl-zak February 27, 2024 17:49

Greavesy1899 self-assigned this Feb 27, 2024

Greavesy1899 commented Feb 27, 2024

View reviewed changes

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h Show resolved Hide resolved

Greavesy1899 commented Feb 27, 2024

View reviewed changes

code/client/src/sdk/ue/game/traffic/c_race_manager.h Show resolved Hide resolved

Segfaultd requested changes Feb 27, 2024

View reviewed changes

Deewarz reviewed Feb 27, 2024

View reviewed changes

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h Outdated Show resolved Hide resolved

Deewarz reviewed Feb 27, 2024

View reviewed changes

code/client/src/sdk/mafia/ui/hud/c_hud_controller.h Outdated Show resolved Hide resolved

Greavesy1899 added 3 commits March 6, 2024 20:28

cleaning up code

86ec9e2

C_RaceTimer: Using patterns, removed MP references

459bbe5

reorganise includes

676380e

Deewarz requested review from Deewarz and Segfaultd March 6, 2024 20:57

Deewarz requested changes Mar 6, 2024

View reviewed changes

Deewarz reviewed Mar 6, 2024

View reviewed changes

latest changes

65e82cd

Greavesy1899 commented Jul 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Racing UI API #100

Racing UI API #100

Greavesy1899 commented Feb 27, 2024

Greavesy1899 Feb 27, 2024

Segfaultd Feb 27, 2024

Segfaultd Feb 27, 2024

Segfaultd Feb 27, 2024

Segfaultd Feb 27, 2024

Segfaultd Feb 27, 2024

Greavesy1899 Mar 6, 2024 •

edited

Loading

Deewarz Feb 27, 2024

Greavesy1899 Mar 6, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Greavesy1899 Mar 6, 2024

Deewarz Mar 6, 2024 •

edited

Loading

Deewarz Mar 6, 2024 •

edited

Loading

Greavesy1899 Mar 6, 2024

Greavesy1899 Mar 6, 2024

Deewarz Mar 6, 2024

Greavesy1899 Mar 6, 2024 •

edited

Loading

zpl-zak Mar 7, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Deewarz Mar 6, 2024

Greavesy1899 Jul 21, 2024

		using namespace SDK::mafia::ui;
		using namespace SDK::mafia::database;

		// need to cast to C_UIDatabase
		// TODO: Feels like this should be dynamic_cast, rather than reinterpret_cast

		#include "sdk/ue/sys/sodb/c_database_interface.h"
		#include "sdk/ue/c_weak_ptr.h"

		@@ -0,0 +1,39 @@
		#pragma once

		#include "sdk/ue/sys/sodb/c_database_interface.h"

		#include "sdk/mafia/database/c_ui_database.h"
		#include "sdk/mafia/ui/c_game_gui_2_module.h"

Racing UI API #100

Are you sure you want to change the base?

Racing UI API #100

Conversation

Greavesy1899 commented Feb 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greavesy1899 Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Deewarz Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Deewarz Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greavesy1899 Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Greavesy1899 Mar 6, 2024 •

edited

Loading

Deewarz Mar 6, 2024 •

edited

Loading

Deewarz Mar 6, 2024 •

edited

Loading

Greavesy1899 Mar 6, 2024 •

edited

Loading