ItsEasyActually at 18:04, 8 October 2025

2025-10-08T18:04:51Z

Show changes

ItsEasyActually at 14:19, 8 October 2025

2025-10-08T14:19:23Z

Show changes

ItsEasyActually: Added missing methods.

2025-10-04T14:41:23Z

Added missing methods.

Show changes

ItsEasyActually: Adding initial SADX Mod Loader page + documentation.

2025-10-04T14:29:58Z

Adding initial SADX Mod Loader page + documentation.

New page

[https://github.com/X-Hax/sadx-mod-loader/ Source Code]

= HelperFunctions API =

== Struct ==
Below is the initialized version of the HelperFunctions struct. For the definition of the struct, you can find that in [https://github.com/X-Hax/sadx-mod-loader/blob/master/SADXModLoader/include/SADXModInfo.h SADXModInfo.h]
<syntaxhighlight lang="cpp">
HelperFunctions helperFunctions =
{
ModLoaderVer,
&RegisterStartPosition,
&ClearStartPositionList,
&RegisterFieldStartPosition,
&ClearFieldStartPositionList,
&RegisterPathList,
&ClearPathListList,
&RegisterCharacterPVM,
&ClearCharacterPVMList,
&RegisterCommonObjectPVM,
&ClearCommonObjectPVMList,
&RegisterTrialLevel,
&ClearTrialLevelList,
&RegisterTrialSubgame,
&ClearTrialSubgameList,
&GetMainSavePath,
&GetChaoSavePath,
&GetReplaceablePath,
&_ReplaceFile,
&SetWindowTitle,
&RegisterSoundList,
&RegisterMusicFile,
&LoadEXEData,
&LoadDLLData,
&_ReplaceFileForce,
&PushScaleUI,
&PopScaleUI,
&SetScaleFillMode,
&GetScaleFillMode,
&ReplaceTexture,
&MipmapBlacklistGBIX,
&RegisterEnglishVoiceDuration,
&RegisterJapaneseVoiceDuration,
&RegisterCharacterWelds,
&loaderSettings,
&modList,
&weightFuncs,
&RegisterVoice,
&PushInterpolationFix,
&PopInterpolationFix,
&RegisterPermanentTexlist,
&ExpandPVMList,
&UnreplaceFile,
};
</syntaxhighlight>

== Properties ==

=== Mod Loader Version ===
<syntaxhighlight lang="cpp">
int ModLoaderVer;
</syntaxhighlight>

This returns the version of the mod loader. This can be used to check if the user has an old version of the mod loader that may not have functionality your mod requires.

==== Example ====
<syntaxhighlight lang="cpp">
if (globalHelperFunctions.ModLoaderVer <= 10)
PrintDebug("This Mod Loader is way out of date.\n");
</syntaxhighlight>
<hr>

=== Mod Loader Settings ===
<syntaxhighlight lang="cpp">
LoaderSettings loaderSettings;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mod List ===
<syntaxhighlight lang="cpp">
std::vector<Mod> modlist;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Weight Functions ===
<syntaxhighlight lang="cpp">
BasicWeightFuncs weightFuncs;
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>

== Functions ==

=== Register Start Position ===
<syntaxhighlight lang="cpp">
static void RegisterStartPosition(unsigned char character, const StartPosition& position)
</syntaxhighlight>

Registers a new Start Position for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
StartPosition myStageStartPos = {
1, // Level ID
0, // Act ID
{ 100.0f, 200.0f, 100.0f }, // Position
0 // Y Rotation
};

// We pass our StagePosition variable as a pointer to this function
// and we have specified Sonic, so the level for this ID would now use
// our StartPosition instead of the original.
globalHelperFunctions.RegisterStartPosition(Characters_Sonic, &myStageStartPos);
</syntaxhighlight>
<hr>

=== Clear Start Position List ===
<syntaxhighlight lang="cpp">
static void ClearStartPositionList(unsigned char character)
</syntaxhighlight>

Clears the Start Positions for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
// Running this inside of your mod's Init export would
// clear all of Sonic's Start Positions for his stages.
globalHelperFunctions.ClearStartPositionList(Characters_Sonic);
</syntaxhighlight>
<hr>

=== Register Field Position ===
<syntaxhighlight lang="cpp">
static void RegisterFieldStartPosition(unsigned char character, const FieldStartPosition& position)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Field Start Position List ===
<syntaxhighlight lang="cpp">
static void ClearFieldStartPositionList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Path List ===
<syntaxhighlight lang="cpp">
static void RegisterPathList(const PathDataPtr& paths)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Path List List ===
<syntaxhighlight lang="cpp">
static void ClearPathListList()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Character PVM ===
<syntaxhighlight lang="cpp">
static void RegisterCharacterPVM(unsigned char character, const PVMEntry& pvm)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Character PVM List ===
<syntaxhighlight lang="cpp">
static void ClearCharacterPVMList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Common Object PVM ===
<syntaxhighlight lang="cpp">
static void RegisterCommonObjectPVM(const PVMEntry& pvm)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Common Object PVM List ===
<syntaxhighlight lang="cpp">
static void ClearCommonObjectPVMList()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Trial Level ===
<syntaxhighlight lang="cpp">
static void RegisterTrialLevel(unsigned char character, const TrialLevelListEntry& level)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Trial Level List ===
<syntaxhighlight lang="cpp">
static void ClearTrialLevelList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Trial Subgame ===
<syntaxhighlight lang="cpp">
static void RegisterTrialSubgame(unsigned char character, const TrialLevelListEntry& level)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Clear Trial Subgame List ===
<syntaxhighlight lang="cpp">
static void ClearTrialSubgameList(unsigned char character)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Main Save Path ===
<syntaxhighlight lang="cpp">
static const char* GetMainSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Chao Save Path ===
<syntaxhighlight lang="cpp">
static const char* GetChaoSavePath()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Replaceable Path ===
<syntaxhighlight lang="cpp">
const char* __cdecl GetReplaceablePath(const char* path)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File ===
<syntaxhighlight lang="cpp">
void _ReplaceFile(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Window Title ===
<syntaxhighlight lang="cpp">
void SetWindowTitle(const char* title)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Sound List ===
<syntaxhighlight lang="cpp">
int RegisterSoundList(const SoundList& list)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Music File ===
<syntaxhighlight lang="cpp">
int RegisterMusicFile(const MusicInfo& track)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Load EXE Data ===
<syntaxhighlight lang="cpp">
void LoadEXEData(const wchar_t* filename, const wchar_t* mod_dir)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Load DLL Data ===
<syntaxhighlight lang="cpp">
void LoadDLLData(const wchar_t* filename, const wchar_t* mod_dir)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace File Force ===
<syntaxhighlight lang="cpp">
void _ReplaceFileForce(const char* src, const char* dst)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Scale UI ===
<syntaxhighlight lang="cpp">
void PushScaleUI(uiscale::Align align, bool is_background, float ratio_h, float ratio_v)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Scale UI ===
<syntaxhighlight lang="cpp">
void PopScaleUI()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Set Scale Fill Mode ===
<syntaxhighlight lang="cpp">
void SetScaleFillMode(uiscale::FillMode mode)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Get Scale Fill Mode ===
<syntaxhighlight lang="cpp">
uiscale::FillMode GetScaleFillMode()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Replace Texture ===
<syntaxhighlight lang="cpp">
void ReplaceTexture(const char* pvm_name, const char* tex_name, const char* file_path, uint32_t gbix, uint32_t width, uint32_t height)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Mipmap Blacklist GBIX ===
<syntaxhighlight lang="cpp">
void MipmapBlacklistGBIX(Uint32 index)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register English Voice Duration ===
<syntaxhighlight lang="cpp">
void RegisterEnglishVoiceDuration(const uint16_t voiceID, const uint16_t duration)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Japanese Voice Duration ===
<syntaxhighlight lang="cpp">
void RegisterJapaneseVoiceDuration(const uint16_t voiceID, const uint16_t duration)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Character Welds ===
<syntaxhighlight lang="cpp">
void RegisterCharacterWelds(const uint8_t character, const char* iniPath)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Voice ===
<syntaxhighlight lang="cpp">
uint16_t RegisterVoice(const char* fileJP, const char* fileEN, uint16_t durationJP, uint16_t durationEN)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Push Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PushInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Pop Interpolation Fix ===
<syntaxhighlight lang="cpp">
void PopInterpolationFix()
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Register Permanent Texlist ===
<syntaxhighlight lang="cpp">
void RegisterPermanentTexlist(NJS_TEXLIST* texlist)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Unreplace File ===
<syntaxhighlight lang="cpp">
void UnreplaceFile(const char* file)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

=== Expand PVM List ===
<syntaxhighlight lang="cpp">
TEX_PVMTABLE* ExpandPVMList(TEX_PVMTABLE* sourcepvmlist, const TEX_PVMTABLE &newpvmentry)
</syntaxhighlight>

==== Example ====
<syntaxhighlight lang="cpp">

</syntaxhighlight>
<hr>

SADX Mod Loader - Revision history

ItsEasyActually at 18:04, 8 October 2025

ItsEasyActually at 14:19, 8 October 2025

ItsEasyActually: Added missing methods.

ItsEasyActually: Adding initial SADX Mod Loader page + documentation.