BaseMod::HookApi Class Reference

Inheritance diagram for BaseMod::HookApi:

Public Member Functions
uint32_t	RemoveHook (HookId id)
	Removes a hook from the registry.
HookId	AfterPeekMessage (BaseMod_PeekMessageHook hookFn, void *userData)
	Registers a hook to the PeekMessage hook.
template<typename T>
HookId	AfterPeekMessage (PeekMessageHook< T > hookFn, T *userData)
	Registers a hook to the PeekMessage hook.
HookId	BeforeGameUpdate (BaseMod_GameUpdateHook hookFn, void *userData)
	Registers a hook to run before the game state updates.
template<typename T>
HookId	BeforeGameUpdate (GameUpdateHook< T > hookFn, T *userData)
	Registers a hook to run before the game state updates.
HookId	AfterGameUpdate (BaseMod_GameUpdateHook hookFn, void *userData)
	Registers a hook to run after the game state updates.
template<typename T>
HookId	AfterGameUpdate (GameUpdateHook< T > hookFn, T *userData)
	Registers a hook to run after the game state updates.
HookId	BeforeEndScene (BaseMod_DrawHook hookFn, void *userData)
	Registers a hook to run before the call to IDirect3DDevice9::EndScene.
template<typename T>
HookId	BeforeEndScene (DrawHook< T > hookFn, T *userData)
	Registers a hook to run before the call to IDirect3DDevice9::EndScene.
HookId	BeforePresent (BaseMod_DrawHook hookFn, void *userData)
	Registers a hook to run before the call to IDirect3DDevice9::Present.
template<typename T>
HookId	BeforePresent (DrawHook< T > hookFn, T *userData)
	Registers a hook to run before the call to IDirect3DDevice9::Present.
HookId	AfterSaveGame (BaseMod_SaveGameHook hookFn, void *userData)
	Registers a hook to run when the game saves such as on "Saving..." auto saving screens Or when selecting the menu option: "Main Menu > HELP & OPTIONS > SAVE / LOAD > SAVE".
template<typename T>
HookId	AfterSaveGame (SaveGameHook< T > hookFn, T *userData)
	Registers a hook to run when the game saves such as on "Saving..." auto saving screens Or when selecting the menu option: "Main Menu > HELP & OPTIONS > SAVE / LOAD > SAVE".
Public Member Functions inherited from BaseMod::ApiWrapper< BaseMod_HookApi >
bool	VersionError ()
bool	IsValid ()
const BaseMod_HookApi *	GetCApi ()

Additional Inherited Members
Protected Attributes inherited from BaseMod::ApiWrapper< BaseMod_HookApi >
const BaseMod_HookApi *	_ref

Member Function Documentation

AfterGameUpdate() [1/2]

HookId BaseMod::HookApi::AfterGameUpdate ( BaseMod_GameUpdateHook hookFn, void * userData )

inline

Registers a hook to run after the game state updates.

Use this to read game state as soon as it updates or to overwrite the game state right after the game updates it.

Parameters

hookFn	The callback function, see type BaseMod_GameUpdateHook.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                          {
        return _ref->AfterGameUpdate(hookFn, userData);
    }

AfterGameUpdate() [2/2]

template<typename T>

HookId BaseMod::HookApi::AfterGameUpdate ( GameUpdateHook< T > hookFn, T * userData )

inline

Registers a hook to run after the game state updates.

Use this to read game state as soon as it updates or to overwrite the game state right after the game updates it. Template version for type safety on the userData pointer.

Parameters

hookFn	The callback function, see type GameUpdateHook<T>.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                  {
        return _ref->AfterGameUpdate(
            reinterpret_cast<BaseMod_GameUpdateHook>(hookFn),
            userData);
    }

AfterPeekMessage() [1/2]

HookId BaseMod::HookApi::AfterPeekMessage ( BaseMod_PeekMessageHook hookFn, void * userData )

inline

Registers a hook to the PeekMessage hook.

Use this to read windows message such as low level keyboard inputs. This hook is a call replacement and not a direct PeekMessage hook so callbacks are only called for messages retrieved by the game window. The parameters used to call PeekMessage are provided in the BaseMod_PeekMessageInfo parameter of BaseMod_PeekMessageHook.

Parameters

hookFn	The callback function, see type BaseMod_PeekMessageHook.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                            {
        return _ref->AfterPeekMessage(hookFn, userData);
    }

AfterPeekMessage() [2/2]

template<typename T>

HookId BaseMod::HookApi::AfterPeekMessage ( PeekMessageHook< T > hookFn, T * userData )

inline

Registers a hook to the PeekMessage hook.

Use this to read windows message such as low level keyboard inputs. This hook is a call replacement and not a direct PeekMessage hook so callbacks are only called for messages retrieved by the game window. The parameters used to call PeekMessage are provided in the BaseMod_PeekMessageInfo parameter of BaseMod::PeekMessageHook<T>. Template version for type safety on the userData pointer.

Parameters

hookFn	The callback function, see type PeekMessageHook<T>.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                    {
        return _ref->AfterPeekMessage(
            reinterpret_cast<BaseMod_PeekMessageHook>(hookFn),
            userData);
    }

AfterSaveGame() [1/2]

HookId BaseMod::HookApi::AfterSaveGame ( BaseMod_SaveGameHook hookFn, void * userData )

inline

Registers a hook to run when the game saves such as on "Saving..." auto saving screens Or when selecting the menu option: "Main Menu > HELP & OPTIONS > SAVE / LOAD > SAVE".

Use this hook to trigger saving mod data.

Parameters

hookFn	The callback function, see type BaseMod_SaveGameHook.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                      {
        return _ref->AfterSaveGame(hookFn, userData);
    }

AfterSaveGame() [2/2]

template<typename T>

HookId BaseMod::HookApi::AfterSaveGame ( SaveGameHook< T > hookFn, T * userData )

inline

Registers a hook to run when the game saves such as on "Saving..." auto saving screens Or when selecting the menu option: "Main Menu > HELP & OPTIONS > SAVE / LOAD > SAVE".

Use this hook to trigger saving mod data.

Parameters

hookFn	The callback function, see type SaveGameHook<T>.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                              {
        return _ref->AfterSaveGame(
            reinterpret_cast<BaseMod_SaveGameHook>(hookFn),
            userData
        );
    }

BeforeEndScene() [1/2]

HookId BaseMod::HookApi::BeforeEndScene ( BaseMod_DrawHook hookFn, void * userData )

inline

Registers a hook to run before the call to IDirect3DDevice9::EndScene.

Use this to add additional graphics logic to the game's main scene.

Parameters

hookFn	The callback function, see type BaseMod_DrawHook.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                   {
        return _ref->BeforeEndScene(hookFn, userData);
    }

BeforeEndScene() [2/2]

template<typename T>

HookId BaseMod::HookApi::BeforeEndScene ( DrawHook< T > hookFn, T * userData )

inline

Registers a hook to run before the call to IDirect3DDevice9::EndScene.

Use this to add additional graphics logic to the game's main scene. Template version for type safety on the userData pointer.

Parameters

hookFn	The callback function, see type DrawHook<T>.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                           {
        return _ref->BeforeEndScene(
            reinterpret_cast<BaseMod_DrawHook>(hookFn),
            userData);
    }

BeforeGameUpdate() [1/2]

HookId BaseMod::HookApi::BeforeGameUpdate ( BaseMod_GameUpdateHook hookFn, void * userData )

inline

Registers a hook to run before the game state updates.

Use this to apply changes to the game state right before it runs an update.

Parameters

hookFn	The callback function, see type BaseMod_GameUpdateHook.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                           {
        return _ref->BeforeGameUpdate(hookFn, userData);
    }

BeforeGameUpdate() [2/2]

template<typename T>

HookId BaseMod::HookApi::BeforeGameUpdate ( GameUpdateHook< T > hookFn, T * userData )

inline

Registers a hook to run before the game state updates.

Use this to apply changes to the game state right before it runs an update. Template version for type safety on the userData pointer.

Parameters

hookFn	The callback function, see type GameUpdateHook<T>.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                   {
        return _ref->BeforeGameUpdate(
            reinterpret_cast<BaseMod_GameUpdateHook>(hookFn),
            userData);
    }

BeforePresent() [1/2]

HookId BaseMod::HookApi::BeforePresent ( BaseMod_DrawHook hookFn, void * userData )

inline

Registers a hook to run before the call to IDirect3DDevice9::Present.

Use this to add a new scene to the current frame. Hooks registered must start and end their own scene with IDirect3DDevice9::BeginScene and IDirect3DDevice9::EndScene.

Parameters

hookFn	The callback function, see type BaseMod_DrawHook.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                                  {
        return _ref->BeforePresent(hookFn, userData);
    }

BeforePresent() [2/2]

template<typename T>

HookId BaseMod::HookApi::BeforePresent ( DrawHook< T > hookFn, T * userData )

inline

Registers a hook to run before the call to IDirect3DDevice9::Present.

Use this to add a new scene to the current frame. Hooks registered must start and end their own scene with IDirect3DDevice9::BeginScene and IDirect3DDevice9::EndScene. Template version for type safety on the userData pointer.

Parameters

hookFn	The callback function, see type DrawHook<T>.
userData	A generic pointer to state data that will be forwarded to hookFn.

Returns

A hook id value that can be passed to RemoveHook.

                                                          {
        return _ref->BeforePresent(
            reinterpret_cast<BaseMod_DrawHook>(hookFn),
            userData);
    }

RemoveHook()

uint32_t BaseMod::HookApi::RemoveHook ( HookId id )

inline

Removes a hook from the registry.

Parameters

id	The BaseMod::HookId of the hook to be removed.

Returns

zero if no error occurred, otherwise returns the error code.

                                   {
        return _ref->RemoveHook(id);
    }

---

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

• baseMod.hpp