ItsEasyActually at 17:52, 8 October 2025

2025-10-08T17:52:30Z

Show changes

ItsEasyActually at 15:15, 8 October 2025

2025-10-08T15:15:12Z

Show changes

ItsEasyActually: Writing SA2B Mod Loader page and documentation.

2025-10-04T14:51:21Z

Writing SA2B Mod Loader page and documentation.

New page

[https://github.com/X-Hax/sa2-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/sa2-mod-loader/blob/master/SA2ModLoader/include/SA2ModInfo.h SA2ModInfo.h]
<syntaxhighlight lang="cpp">
HelperFunctions helperFunctions =
{
ModLoaderVer,
RegisterStartPosition,
ClearStartPositionList,
Register2PIntroPosition,
Clear2PIntroPositionList,
GetMainSavePath,
GetChaoSavePath,
RegisterEndPosition,
ClearEndPositionList,
RegisterMission23EndPosition,
ClearMission23EndPositionList,
HookExport,
GetReplaceablePath,
_ReplaceFile,
SetWindowTitle,
debug_text::SetFontSize,
debug_text::SetFontColor,
debug_text::DisplayString,
debug_text::DisplayStringFormatted,
debug_text::DisplayNumber,
&loaderSettings,
&modList,
&RegisterVoice,
&ReplaceTexture,
&UnreplaceFile,
&PushInterpolationFix,
&PopInterpolationFix,
};
</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>

== Functions ==

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

Registers a Start Position for the specified character.

==== Example ====
<syntaxhighlight lang="cpp">
// This is a declaration of an SA2 StartPosition struct.
StartPosition myStageStartPos = {
1, // Level ID
0x4000, // Single Player Y Rotation
0x4000, // Multiplayer, Player 1 Y Rotation
0x4000, // Multiplayer, Player 2 Y Rotation
{ 100.0f, 200.0f, 100.0f }, // Single Player Start Position
{ 90.0f, 200.0f, 100.0f }, // Multiplayer, Player 1 Start Position
{ 110.0f, 200.0f, 100.0f } // Multiplayer, Player 2 Start Position
};

// 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">
void ClearStartPositionList(unsigned char character)
</syntaxhighlight>

Clears the Start Positions for the specified character.

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

</syntaxhighlight>
<hr>

=== Register 2P Intro Position ===
<syntaxhighlight lang="cpp">
void Register2PIntroPosition(unsigned char character, const LevelEndPosition& position)
</syntaxhighlight>

Registers a Multiplayer Intro Position for the specified character.

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

</syntaxhighlight>
<hr>

=== Clear 2P Intro Position List ===
<syntaxhighlight lang="cpp">
void Clear2PIntroPositionList(unsigned char character)
</syntaxhighlight>

Clears all Multiplayer Intro Positions for the specified character.

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

</syntaxhighlight>
<hr>

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

Returns the game's Main Save File's path.

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

</syntaxhighlight>
<hr>

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

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

</syntaxhighlight>
<hr>

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

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

</syntaxhighlight>
<hr>

=== Clear End Position List ===
<syntaxhighlight lang="cpp">
void ClearEndPositionList(unsigned char character)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Register Mission 2/3 End Position ===
<syntaxhighlight lang="cpp">
void RegisterMission23EndPosition(unsigned char character, const LevelEndPosition& position)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Clear Mission 2/3 End Position List ===
<syntaxhighlight lang="cpp">
void ClearMission23EndPositionList(unsigned char character)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Hook Export ===
<syntaxhighlight lang="cpp">
void HookExport(LPCSTR exportName, const void* newdata)
</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 wchar_t* title)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Debug Text : Set Font Size ===
<syntaxhighlight lang="cpp">
void SetFontSize(float size)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Debug Text : Set Font Color ===
<syntaxhighlight lang="cpp">
void SetFontColor(int color)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Debug Text : Display String ===
<syntaxhighlight lang="cpp">
void DisplayString(int loc, const char* str)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Debug Text : Display String Formatted ===
<syntaxhighlight lang="cpp">
void DisplayStringFormatted(int loc, const char* Format, ...)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Debug Text : Display Number ===
<syntaxhighlight lang="cpp">
void DisplayNumber(int loc, int value, int numdigits)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Register Voice ===
<syntaxhighlight lang="cpp">
uint16_t RegisterVoice(const char* fileJP, const char* fileEN)
</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>

=== Unreplace File ===
<syntaxhighlight lang="cpp">
void UnreplaceFile(const char* file)
</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>

=== Get File Mod Index ===
<syntaxhighlight lang="cpp">
int GetFileModIndex(const char* path)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

=== Replace File At Index ===
<syntaxhighlight lang="cpp">
void ReplaceFileAtIndex(const char* src, const char* dst, int modIndex)
</syntaxhighlight>

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

</syntaxhighlight>
<hr>

SA2B Mod Loader - Revision history

ItsEasyActually at 17:52, 8 October 2025

ItsEasyActually at 15:15, 8 October 2025

ItsEasyActually: Writing SA2B Mod Loader page and documentation.