Represents the Spellforce Spell Framework API.This structure serves as the central interface for interacting with various subsystems of the Spellforce Spell Framework. Each member corresponds to a specific API or function group, providing access to the relevant functionality. More...

#include <sfsf.h>

Collaboration diagram for SpellforceSpellFramework:

[legend]

Data Fields
createModInfo_ptr	createModInfo
	Pointer to the function responsible for creating mod information.

SpellFunctions *	spellAPI
	Interface for spell-related functions.

ToolboxFunctions *	toolboxAPI
	Interface for toolbox-related functions.

FigureFunctions *	figureAPI
	Interface for figure-related functions. Facilitates interactions with figures (e.g., npc, units).

IteratorFunctions *	iteratorAPI
	Interface for iterator-related functions.

RegistrationFunctions *	registrationAPI
	Interface for registration-related functions.

EffectFunctions *	effectAPI
	Interface for spell effect-related functions. Provides access to functions that allow setting effect related data.

AiFunctions *	aiAPI
	Interface for AI-related functions.

SFLog *	logAPI
	Interface for logging functionality. Enables logging of information, warnings, and errors to assist in debugging and monitoring.

Detailed Description

Represents the Spellforce Spell Framework API.

This structure serves as the central interface for interacting with various subsystems of the Spellforce Spell Framework. Each member corresponds to a specific API or function group, providing access to the relevant functionality.

Definition at line 35 of file sfsf.h.

Field Documentation

◆ aiAPI

AiFunctions* SpellforceSpellFramework::aiAPI

Interface for AI-related functions.

Provides tools for interacting with AI systems.

Definition at line 87 of file sfsf.h.

◆ createModInfo

createModInfo_ptr SpellforceSpellFramework::createModInfo

Pointer to the function responsible for creating mod information.

Definition at line 40 of file sfsf.h.

◆ effectAPI

EffectFunctions* SpellforceSpellFramework::effectAPI

Interface for spell effect-related functions. Provides access to functions that allow setting effect related data.

Definition at line 80 of file sfsf.h.

◆ figureAPI

FigureFunctions* SpellforceSpellFramework::figureAPI

Interface for figure-related functions. Facilitates interactions with figures (e.g., npc, units).

Definition at line 60 of file sfsf.h.

◆ iteratorAPI

IteratorFunctions* SpellforceSpellFramework::iteratorAPI

Interface for iterator-related functions.

Provides functionality for managing and navigating collections or sequences of objects.

Definition at line 67 of file sfsf.h.

◆ logAPI

SFLog* SpellforceSpellFramework::logAPI

Interface for logging functionality. Enables logging of information, warnings, and errors to assist in debugging and monitoring.

Definition at line 93 of file sfsf.h.

◆ registrationAPI

RegistrationFunctions* SpellforceSpellFramework::registrationAPI

Interface for registration-related functions.

Handles the registration of new spells within the framework.

Definition at line 74 of file sfsf.h.

◆ spellAPI

SpellFunctions* SpellforceSpellFramework::spellAPI

Interface for spell-related functions.

Provides utilities for managing and manipulating spells within the framework.

Definition at line 47 of file sfsf.h.

◆ toolboxAPI

ToolboxFunctions* SpellforceSpellFramework::toolboxAPI

Interface for toolbox-related functions.

Offers general-purpose tools and utilities to assist with framework operations.

Definition at line 54 of file sfsf.h.

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

src/api/sfsf.h

Data Fields