sf_registry.h File Reference

#include "../../api/sfsf.h"

Include dependency graph for sf_registry.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	initialize_framework ()
	Initializes the Spellforce Spell Framework (SFSF).

Variables
SpellforceSpellFramework	frameworkAPI

Function Documentation

initialize_framework()

void initialize_framework ( )

extern

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 99 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

extern

Definition at line 39 of file sf_registry.cpp.