mirror of
https://github.com/hedge-dev/UnleashedRecomp.git
synced 2026-04-30 15:29:16 -05:00
api: update research
This commit is contained in:
Hyper
@@ -5,7 +5,7 @@
|
||||
#include <CSD/Manager/csdmResourceBase.h>
|
||||
#include <CSD/Manager/csdmNodeObserver.h>
|
||||
#include <CSD/Manager/csdmSubjectBase.h>
|
||||
#include <Hedgehog/Math/Vector2.h>
|
||||
#include <Hedgehog/Math/Vector.h>
|
||||
|
||||
namespace Chao::CSD
|
||||
{
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
#pragma once
|
||||
|
||||
#include "SWA.inl"
|
||||
|
||||
namespace Hedgehog::Math
|
||||
{
|
||||
class CVector2
|
||||
{
|
||||
public:
|
||||
be<float> X;
|
||||
be<float> Y;
|
||||
};
|
||||
|
||||
class CVector
|
||||
{
|
||||
public:
|
||||
be<float> X;
|
||||
be<float> Y;
|
||||
be<float> Z;
|
||||
};
|
||||
|
||||
class CVector4
|
||||
{
|
||||
public:
|
||||
be<float> X;
|
||||
be<float> Y;
|
||||
be<float> Z;
|
||||
be<float> W;
|
||||
};
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include "SWA.inl"
|
||||
|
||||
namespace Hedgehog::Math
|
||||
{
|
||||
class CVector2
|
||||
{
|
||||
public:
|
||||
be<float> X;
|
||||
be<float> Y;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,47 @@
|
||||
# SWA
|
||||
|
||||
## Contribution Guide
|
||||
|
||||
### Naming Conventions
|
||||
|
||||
- Use `camelCase` for local variables, `SNAKE_CASE` for preprocessor macros, and `PascalCase` for everything else. SWA-specific types that don't exist in the game should use `snake_case` for better differentiation.
|
||||
- Class names should be prefixed with `C`, e.g., `CSonicContext`.
|
||||
- Struct names should be prefixed with `S`, e.g., `SUpdateInfo`.
|
||||
- Class members should be prefixed with `m_`, e.g., `m_Time`. Do not use this prefix for struct members.
|
||||
- Enum names should be prefixed with `E`, e.g., `ELightType`.
|
||||
- Enum members should start with `e`, followed by the enum name and an underscore, e.g., `eLightType_Point`.
|
||||
- For enum members indicating the count of elements, prefix with `n`, followed by the name, e.g., `nLightType`.
|
||||
- Pointers should be prefixed with `p`, e.g., `pSonicContext`.
|
||||
- Shared pointers should be prefixed with `sp`, e.g., `spDatabase`.
|
||||
- References should be prefixed with `r`, e.g., `rMessage`.
|
||||
- Input function arguments should be prefixed with `in_`, e.g., `in_Name`.
|
||||
- Output function arguments should be prefixed with `out_`, e.g., `out_Value`.
|
||||
- Static class members should be prefixed with `ms_`, e.g., `ms_Instance`.
|
||||
- Static members outside a class should be prefixed with `g_`, e.g., `g_AllocationTracker`.
|
||||
- SWA-specific preprocessor macros should start with `SWA_`, e.g., `SWA_INSERT_PADDING`.
|
||||
- Hedgehog namespace-specific preprocessor macros should start with `HH_` along with the library's shorthand, e.g., `HH_FND_MSG_MAKE_TYPE`.
|
||||
- Function pointers should be prefixed with `fp`, e.g., `fpCGameObjectConstructor`.
|
||||
|
||||
Combine prefixes as necessary, e.g., `m_sp` for a shared pointer as a class member or `in_r` for a const reference as a function argument.
|
||||
|
||||
### Coding Style
|
||||
|
||||
- Always place curly brackets on a new line.
|
||||
- Prefer forward declaring types over including their respective headers.
|
||||
- Use <> includes relative to the project's root directory path.
|
||||
- Use C++17's nested namespace feature instead of defining multiple namespaces on separate lines.
|
||||
- Enum classes are prohibited as they were not available when the game was developed.
|
||||
- Avoid placing function definitions in .h files, instead, implement functions in the header's respective .inl file, similar to a .cpp file.
|
||||
- Ensure that all class members are declared as public. Even if you suspect that a class member was private in the original code, having it public is more convenient in a modding API.
|
||||
- Avoid placing multiple class definitions in a single header file unless you have a good reason to do so.
|
||||
- Keep function pointers or addresses outside functions, define them as global variables in the corresponding .inl file. Mark these global variables as `inline` and never nest them within class definitions. You do not need to use the `g_` prefix for function pointers, `fp` is sufficient.
|
||||
- Use primitive types defined in `cstdint` instead of using types that come with the language, e.g., use `uint32_t` instead of `unsigned int`. Using `float`, `double` and `bool` is okay.
|
||||
|
||||
### Mapping Rules
|
||||
|
||||
- Always include the corresponding `offsetof`/`sizeof` assertions for mapped classes/structs. If you are uncertain about the type's size, you can omit the `sizeof` assertion.
|
||||
- Use the exact type name from the game if it's available through RTTI, otherwise, you can look for shared pointers that may reveal the original type name.
|
||||
- If you are unsure about the name of a class/struct member, use `Field` followed by the hexadecimal byte offset (e.g., `m_Field194`). Avoid names like `m_StoresThisThingMaybe`, you can write comments next to the definition for speculations.
|
||||
- If a portion of the byte range is irrelevant to your research or not mapped yet, use the `SWA_INSERT_PADDING` macro to align class/struct members correctly.
|
||||
- When the class has a virtual function table, if you don't want to map every function in it, you can map only the virtual destructor.
|
||||
- The original file locations are likely available in the executable file as assertion file paths. If you cannot find the file path, use your intuition to place the file in a sensible place.
|
||||
@@ -27,7 +27,7 @@
|
||||
#include "Hedgehog/Base/Type/hhSharedString.h"
|
||||
#include "Hedgehog/Base/hhObject.h"
|
||||
#include "Hedgehog/Database/System/hhDatabaseData.h"
|
||||
#include "Hedgehog/Math/Vector2.h"
|
||||
#include "Hedgehog/Math/Vector.h"
|
||||
#include "Hedgehog/MirageCore/Misc/hhVertexDeclarationPtr.h"
|
||||
#include "Hedgehog/MirageCore/RenderData/hhMaterialData.h"
|
||||
#include "Hedgehog/MirageCore/RenderData/hhMeshData.h"
|
||||
@@ -89,6 +89,8 @@
|
||||
#include "SWA/System/GameMode/Title/TitleMenu.h"
|
||||
#include "SWA/System/GameMode/Title/TitleStateBase.h"
|
||||
#include "SWA/System/GameObject.h"
|
||||
#include "SWA/System/GameParameter.h"
|
||||
#include "SWA/System/GammaController.h"
|
||||
#include "SWA/System/InputState.h"
|
||||
#include "SWA/System/PadState.h"
|
||||
#include "SWA/System/World.h"
|
||||
|
||||
@@ -2,9 +2,35 @@
|
||||
|
||||
#include <SWA.inl>
|
||||
#include <SWA/System/Game.h>
|
||||
#include <SWA/System/GameParameter.h>
|
||||
#include <SWA/System/GammaController.h>
|
||||
|
||||
namespace Hedgehog::Base
|
||||
{
|
||||
class CCriticalSection;
|
||||
}
|
||||
|
||||
namespace Hedgehog::Database
|
||||
{
|
||||
class CDatabase;
|
||||
}
|
||||
|
||||
namespace Hedgehog::Mirage
|
||||
{
|
||||
class CMatrixNode;
|
||||
class CRenderScene;
|
||||
}
|
||||
|
||||
namespace Hedgehog::Universe
|
||||
{
|
||||
class CParallelJobManagerD3D9;
|
||||
}
|
||||
|
||||
namespace SWA
|
||||
{
|
||||
class CApplication;
|
||||
class CDatabaseTree;
|
||||
|
||||
enum ELanguage : uint32_t
|
||||
{
|
||||
eLanguage_English,
|
||||
@@ -33,12 +59,29 @@ namespace SWA
|
||||
class CMember
|
||||
{
|
||||
public:
|
||||
xpointer<CApplication> m_pApplication;
|
||||
boost::shared_ptr<Hedgehog::Universe::CParallelJobManagerD3D9> m_spParallelJobManagerD3D9;
|
||||
SWA_INSERT_PADDING(0x14);
|
||||
boost::shared_ptr<CGame> m_spGame;
|
||||
SWA_INSERT_PADDING(0x14);
|
||||
boost::shared_ptr<Hedgehog::Database::CDatabase> m_spInspireDatabase;
|
||||
SWA_INSERT_PADDING(0x30);
|
||||
Hedgehog::Base::CSharedString m_Field74;
|
||||
SWA_INSERT_PADDING(0x0C);
|
||||
boost::shared_ptr<Hedgehog::Mirage::CMatrixNode> m_spMatrixNodeRoot;
|
||||
SWA_INSERT_PADDING(0x14);
|
||||
CGammaController m_GammaController;
|
||||
SWA_INSERT_PADDING(0x1C);
|
||||
boost::shared_ptr<Achievement::CManager> m_spAchievementManager;
|
||||
boost::shared_ptr<CDatabaseTree> m_spDatabaseTree;
|
||||
Hedgehog::Base::CSharedString m_Field10C;
|
||||
SWA_INSERT_PADDING(0x1C);
|
||||
boost::shared_ptr<Hedgehog::Mirage::CRenderScene> m_spRenderScene;
|
||||
SWA_INSERT_PADDING(0x04);
|
||||
boost::shared_ptr<CGameParameter> m_spGameParameter;
|
||||
SWA_INSERT_PADDING(0x78);
|
||||
boost::shared_ptr<Hedgehog::Base::CCriticalSection> m_spCriticalSection;
|
||||
SWA_INSERT_PADDING(0x20);
|
||||
boost::shared_ptr<CGame> m_pGame;
|
||||
SWA_INSERT_PADDING(0xD4);
|
||||
xpointer<Achievement::CManager> m_pAchievementManager;
|
||||
SWA_INSERT_PADDING(0x3C);
|
||||
xpointer<void> m_spGameParameter;
|
||||
};
|
||||
|
||||
// TODO: Hedgehog::Base::TSynchronizedPtr<CApplicationDocument>
|
||||
@@ -51,7 +94,31 @@ namespace SWA
|
||||
be<ERegion> m_Region;
|
||||
bool m_InspireVoices;
|
||||
bool m_InspireSubtitles;
|
||||
SWA_INSERT_PADDING(0x28);
|
||||
};
|
||||
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_pApplication, 0x00);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spParallelJobManagerD3D9, 0x04);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spGame, 0x20);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spInspireDatabase, 0x3C);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_Field74, 0x74);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spMatrixNodeRoot, 0x84);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_GammaController, 0xA0);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spAchievementManager, 0xFC);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spDatabaseTree, 0x104);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_Field10C, 0x10C);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spRenderScene, 0x12C);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spGameParameter, 0x138);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument::CMember, m_spCriticalSection, 0x1B8);
|
||||
SWA_ASSERT_SIZEOF(CApplicationDocument::CMember, 0x1E0);
|
||||
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument, m_pMember, 0x04);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument, m_Language, 0x08);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument, m_VoiceLanguage, 0x0C);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument, m_Region, 0x18);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument, m_InspireVoices, 0x1C);
|
||||
SWA_ASSERT_OFFSETOF(CApplicationDocument, m_InspireSubtitles, 0x1D);
|
||||
SWA_ASSERT_SIZEOF(CApplicationDocument, 0x48);
|
||||
}
|
||||
|
||||
#include "ApplicationDocument.inl"
|
||||
|
||||
@@ -13,12 +13,30 @@ namespace SWA
|
||||
class CMember
|
||||
{
|
||||
public:
|
||||
struct SScoreInfo
|
||||
{
|
||||
be<uint32_t> SRank;
|
||||
be<uint32_t> ARank;
|
||||
be<uint32_t> BRank;
|
||||
be<uint32_t> CRank;
|
||||
be<uint32_t> DRank;
|
||||
SWA_INSERT_PADDING(0x0C);
|
||||
be<float> PointMarkerRecordSpeed;
|
||||
SWA_INSERT_PADDING(0x0C);
|
||||
be<uint32_t> PointMarkerCount;
|
||||
be<uint32_t> EnemyScore;
|
||||
be<uint32_t> TrickScore;
|
||||
SWA_INSERT_PADDING(0x10);
|
||||
};
|
||||
|
||||
SWA_INSERT_PADDING(0x1C);
|
||||
boost::shared_ptr<Hedgehog::Database::CDatabase> m_spDatabase;
|
||||
SWA_INSERT_PADDING(0x8C);
|
||||
SWA_INSERT_PADDING(0x88);
|
||||
Hedgehog::Base::CSharedString m_StageName;
|
||||
xpointer<CSoundAdministrator> m_pSoundAdministrator;
|
||||
SWA_INSERT_PADDING(0x158);
|
||||
be<uint32_t> m_Score;
|
||||
SWA_INSERT_PADDING(0x124);
|
||||
SScoreInfo m_ScoreInfo;
|
||||
SWA_INSERT_PADDING(0x0C);
|
||||
};
|
||||
|
||||
// TODO: Hedgehog::Base::TSynchronizedPtr<CGameDocument>
|
||||
@@ -27,6 +45,26 @@ namespace SWA
|
||||
xpointer<void> m_pVftable;
|
||||
xpointer<CMember> m_pMember;
|
||||
};
|
||||
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, SRank, 0x00);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, ARank, 0x04);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, BRank, 0x08);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, CRank, 0x0C);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, DRank, 0x10);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, PointMarkerRecordSpeed, 0x20);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, PointMarkerCount, 0x30);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, EnemyScore, 0x34);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember::SScoreInfo, TrickScore, 0x38);
|
||||
SWA_ASSERT_SIZEOF(CGameDocument::CMember::SScoreInfo, 0x4C);
|
||||
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember, m_spDatabase, 0x1C);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember, m_StageName, 0xAC);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember, m_pSoundAdministrator, 0xB0);
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument::CMember, m_ScoreInfo, 0x1D8);
|
||||
SWA_ASSERT_SIZEOF(CGameDocument::CMember, 0x230);
|
||||
|
||||
SWA_ASSERT_OFFSETOF(CGameDocument, m_pMember, 0x08);
|
||||
SWA_ASSERT_SIZEOF(CGameDocument, 0x0C);
|
||||
}
|
||||
|
||||
#include "GameDocument.inl"
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
#pragma once
|
||||
|
||||
#include <SWA.inl>
|
||||
|
||||
namespace SWA
|
||||
{
|
||||
class CGameParameter // : public Hedgehog::Universe::CMessageActor
|
||||
{
|
||||
public:
|
||||
struct SSaveData;
|
||||
struct SStageParameter;
|
||||
|
||||
SWA_INSERT_PADDING(0x94);
|
||||
xpointer<SSaveData> m_pSaveData;
|
||||
xpointer<SStageParameter> m_pStageParameter;
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
#pragma once
|
||||
|
||||
#include <SWA.inl>
|
||||
#include <Hedgehog/Math/Vector.h>
|
||||
|
||||
namespace SWA
|
||||
{
|
||||
class CGammaController : public Hedgehog::Base::CObject
|
||||
{
|
||||
public:
|
||||
SWA_INSERT_PADDING(0x10);
|
||||
uint8_t m_Field10;
|
||||
SWA_INSERT_PADDING(0x0F);
|
||||
Hedgehog::Math::CVector4 m_Gamma;
|
||||
Hedgehog::Math::CVector4 m_Field30;
|
||||
};
|
||||
|
||||
SWA_ASSERT_OFFSETOF(CGammaController, m_Field10, 0x10);
|
||||
SWA_ASSERT_OFFSETOF(CGammaController, m_Gamma, 0x20);
|
||||
SWA_ASSERT_OFFSETOF(CGammaController, m_Field30, 0x30);
|
||||
SWA_ASSERT_SIZEOF(CGammaController, 0x40);
|
||||
}
|
||||
Reference in New Issue
Block a user