BaseMod_Api Struct Reference

Root struct for the base mod API. More...

#include <baseMod_c.h>

Data Fields
uint32_t	size
	The size of the struct in bytes.
uint32_t	version
	the API version.
const struct BaseMod_NativeFunctionsApi *	NativeFunctions
	API for invoking native game functions.
const struct BaseMod_GameDataApi *	GameData
	Curated access to game data.
const struct BaseMod_HookApi *	Hooks
	Function hooking manager.
const struct BaseMod_ModMenuApi *	ModMenu
	Add options to the mod menu.

Detailed Description

Root struct for the base mod API.

A pointer to an instance of this struct will be given by GearLoaderApi::RetrieveModAPI().

Field Documentation

version

uint32_t BaseMod_Api::version

the API version.

The mod loader will create this struct with the value given by the BASEMOD_API_VERSION_NUM macro. Compare this value with the BASEMOD_API_VERSION_NUM macro to detect version differences between the installed mod loader version and the targeted mod loader API version. The format is a semantic version 0x00AABBCC where 0xAA is major, 0xBB is minor, and 0xCC is patch number.

---

The documentation for this struct was generated from the following file:

• baseMod_c.h