Initializes and configures the Spellforce Spell Framework (SFSF). More...

#include "../core/sf_modloader.h"
#include "../core/sf_wrappers.h"
#include "../core/sf_hooks.h"
#include "../core/sf_campaign_module.h"
#include "../core/sf_screens_module.h"
#include "sf_registry.h"
#include "sf_vanilla_registry.h"
#include "sf_mod_registry.h"
#include "sf_error_registry.h"
#include "spell_data_registries/sf_spelltype_registry.h"
#include "spell_data_registries/sf_spelleffect_registry.h"
#include "spell_data_registries/sf_spellend_registry.h"
#include "spell_data_registries/sf_spellrefresh_registry.h"
#include "spell_data_registries/sf_subeffect_registry.h"
#include "spell_data_registries/sf_spelldamage_registry.h"
#include "spell_data_registries/sf_enchant_registry.h"
#include <windows.h>
#include <iostream>

Include dependency graph for sf_registry.cpp:

Go to the source code of this file.

Functions
void	registerFrameworkAPI ()
	Registers the framework API addresses.
void	initialize_framework ()
	Initializes the Spellforce Spell Framework (SFSF).

Variables
SpellforceSpellFramework	frameworkAPI
SFMod *	g_current_mod
SFMod *	g_framework_mod

Detailed Description

Initializes and configures the Spellforce Spell Framework (SFSF).

This file handles the initialization of various systems required by the Spellforce Spell Framework (SFSF), including setting up low-level hooks, linking APIs, and loading and registering mods. It serves as the core point for the framework to interact with the game, ensuring compatibility and enabling various mod functionalities.

The initialization process includes several phases:

Framework Configuration: Includes setting up API structures and initializing vanilla spells and handlers.
Mod Loading: Loads all compatible mods into the framework.
Mod Registration: Registers spells and functions from the loaded mods.

Note: Ensure that mods are compliant with the framework's API for compatibility.

Definition in file sf_registry.cpp.

Function Documentation

◆ initialize_framework()

void initialize_framework ( )

Initializes the Spellforce Spell Framework (SFSF).

This function initializes the Spellforce Spell Framework (SFSF), setting up hooks, APIs, vanilla spells, and loading/registering mods.

The initialization process includes the following phases:

Framework Configuration Phase:
- Data Hook Initialization: Sets up low-level hooks to the game's memory and functions.
- API Function Linking: Links framework API structures.
- Vanilla Spell Initialization: Registers vanilla spell types and effect handlers.
Mod Loading Phase:
- Loads all mods compatible with the framework.
Mod Registration Phase:
- Registers spells and functions from loaded mods.
  Warning
  Incorrect setup of hooks or APIs can lead to crashes. Mods must adhere to the framework's API for compatibility.
  
  See also
  registerFrameworkAPI(), initialize_data_hooks(), initialize_vanilla_spells(), register_vanilla_effect_handlers(), register_vanilla_spell_end_handlers(), register_vanilla_sub_effect_handlers(), register_vanilla_spell_refresh_handlers(), register_vanilla_spell_damage_handlers(), initialize_mods(), register_mod_spells()

Definition at line 113 of file sf_registry.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerFrameworkAPI()

void registerFrameworkAPI ( )

Registers the framework API addresses.

This function loads the framework's API structure and assigns function pointers for various subsystems, including the figure, spell, toolbox, iterator, registration, and effect APIs. It also sets up logging functionality.

See also: figureAPI, spellAPI, toolboxAPI, iteratorAPI, registrationAPI, effectAPI

Definition at line 57 of file sf_registry.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ frameworkAPI

SpellforceSpellFramework frameworkAPI

Definition at line 44 of file sf_registry.cpp.

◆ g_current_mod

SFMod* g_current_mod

Definition at line 45 of file sf_registry.cpp.

◆ g_framework_mod

SFMod* g_framework_mod

Definition at line 46 of file sf_registry.cpp.

Functions

Variables