core-legacy/sourcemm.h
author David Anderson <dvander@alliedmods.net>
Mon Nov 18 11:22:15 2013 -0800 (2013-11-18)
changeset 881 9c07bcf2b4d4
parent 778 faee01f77160
child 887 e30d4a37f5e5
permissions -rw-r--r--
Push build.
dvander@541
     1
/* ======== SourceMM ========
ds@683
     2
 * Copyright (C) 2004-2009 Metamod:Source Development Team
dvander@541
     3
 * No warranties of any kind
dvander@541
     4
 *
dvander@541
     5
 * License: zlib/libpng
dvander@541
     6
 *
dvander@541
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@541
     8
 * ============================
dvander@541
     9
 */
dvander@541
    10
dvander@541
    11
#ifndef _INCLUDE_SOURCEMM_H
dvander@541
    12
#define _INCLUDE_SOURCEMM_H
dvander@541
    13
dvander@541
    14
/**
dvander@541
    15
 * @brief SourceMM main functionality for GameDLL interception
dvander@541
    16
 * @file sourcemm.h
dvander@541
    17
 */
dvander@541
    18
dvander@541
    19
#include <interface.h>
dvander@541
    20
#include <eiface.h>
dvander@541
    21
#include <sourcehook/sourcehook_impl.h>
dvander@541
    22
#include <sourcehook/sourcehook.h>
dvander@541
    23
#include "ISmmAPI.h"
dvander@541
    24
#include "CPlugin.h"
dvander@541
    25
#include "oslink.h"
ds@706
    26
#include <metamod_version.h>
dvander@580
    27
#include "loader_bridge.h"
dvander@541
    28
dvander@541
    29
/**
dvander@541
    30
 * Versioning
dvander@541
    31
 *   increase api_major when API breaks
dvander@541
    32
 *   increase api_minor when new functions are added (non-breaking)
dvander@541
    33
 */
dvander@541
    34
#define		SOURCEMM_VERSION	SVN_FILE_VERSION_STRING
dvander@541
    35
#define		SOURCEMM_DATE		__DATE__
dvander@541
    36
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
dvander@541
    37
#define		SM_VERS_API_MINOR	5		//increase this on a non-breaking API change
dvander@541
    38
dvander@541
    39
//We need a good CServerGameDLL version to work properly.  We support these inclusively.
dvander@541
    40
#define	MIN_GAMEDLL_VERSION	3
dvander@541
    41
#define	MAX_GAMEDLL_VERSION	8
dvander@541
    42
dvander@541
    43
dvander@583
    44
void *ServerFactory(const char *name, int *code);
dvander@541
    45
void *EngineFactory(const char *name, int *code);
dvander@541
    46
void *PhysicsFactory(const char *name, int *code);
dvander@541
    47
void *FileSystemFactory(const char *name, int *code);
dvander@541
    48
ds@601
    49
/** @brief Loads all plugins found from the mm_pluginsfile file and from VDFs in mm_basedir */
ds@601
    50
int LoadPlugins(const char *filepath, const char *vdfdir);
dvander@541
    51
dvander@541
    52
/** @brief Logs a message to the standard log file */
dvander@541
    53
void LogMessage(const char *msg, ...);
dvander@541
    54
dvander@541
    55
/** @brief Stores information about the GameDLL */
dvander@541
    56
struct GameDllInfo
dvander@541
    57
{
dvander@541
    58
	bool loaded;
dvander@541
    59
	CreateInterfaceFn factory;
dvander@541
    60
	IServerGameDLL *pGameDLL;
dvander@541
    61
	IServerGameClients *pGameClients;
dvander@541
    62
};
dvander@541
    63
dvander@541
    64
/** @brief Stores information about the HL2 Engine pointers */
dvander@541
    65
struct EngineInfo
dvander@541
    66
{
dvander@541
    67
	EngineInfo() : loaded(false), original(false),
dvander@541
    68
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@541
    69
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@541
    70
	{ };
dvander@541
    71
	bool loaded;
dvander@541
    72
	bool original;
dvander@541
    73
	CreateInterfaceFn engineFactory;
dvander@541
    74
	CreateInterfaceFn physicsFactory;
dvander@541
    75
	CreateInterfaceFn fileSystemFactory;
dvander@541
    76
	CGlobalVars *pGlobals;
dvander@541
    77
	ICvar *icvar;
dvander@541
    78
	IVEngineServer *engine;
dvander@541
    79
};
dvander@541
    80
dvander@541
    81
bool AlternatelyLoadMetamod(CreateInterfaceFn ifaceFactory, CreateInterfaceFn serverFactory);
dvander@541
    82
dvander@548
    83
extern IServerPluginCallbacks *g_pRealVspCallbacks;
dvander@548
    84
extern bool g_bIsBridgedAsVsp;
dvander@548
    85
dvander@541
    86
/** @brief Global variable for GameDLL info */
dvander@541
    87
extern GameDllInfo g_GameDll;
dvander@541
    88
dvander@541
    89
/** @brief Global variable for Engine info */
dvander@541
    90
extern EngineInfo g_Engine;
dvander@541
    91
dvander@541
    92
/** @brief Global singleton for SourceHook */
dvander@541
    93
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@541
    94
dvander@541
    95
/** @brief Mod path (important!)*/
dvander@541
    96
extern SourceHook::String g_ModPath;
dvander@541
    97
ds@683
    98
/** @brief Path to Metamod binary */
ds@683
    99
extern SourceHook::String g_MetamodPath;
ds@683
   100
dvander@541
   101
/** @brief Global variable for SourceHook macros */
dvander@541
   102
extern SourceHook::ISourceHook *g_SHPtr;
dvander@541
   103
dvander@541
   104
/** @brief We have our own internal plugin id... */
dvander@541
   105
extern PluginId g_PLID;
dvander@541
   106
dvander@541
   107
/** @brief ServerGameDLL version that is currently loaded */
dvander@541
   108
extern int g_GameDllVersion;
dvander@541
   109
dvander@580
   110
extern bool g_bGameInit;
dvander@541
   111
extern bool g_bLevelChanged;
dvander@541
   112
dvander@666
   113
extern unsigned int g_vsp_version;
dvander@666
   114
dvander@541
   115
void UnloadMetamod(bool shutting_down);
dvander@541
   116
dvander@580
   117
void LoadAsGameDLL(const gamedll_bridge_info *info);
dvander@580
   118
dvander@541
   119
#endif //_INCLUDE_SOURCEMM_H
dvander@580
   120