sourcemm/sourcemm.h
author Scott Ehlert <ds@alliedmods.net>
Fri Aug 10 23:43:16 2007 +0000 (2007-08-10)
changeset 346 d0868271663a
parent 340 a8b4a311a1e0
permissions -rw-r--r--
Reformatted output of meta list command
dvander@7
     1
/* ======== SourceMM ========
dvander@282
     2
 * Copyright (C) 2004-2007 Metamod:Source Development Team
dvander@282
     3
 * No warranties of any kind
dvander@282
     4
 *
dvander@282
     5
 * License: zlib/libpng
dvander@282
     6
 *
dvander@282
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@282
     8
 * ============================
dvander@282
     9
 */
dvander@7
    10
dvander@7
    11
#ifndef _INCLUDE_SOURCEMM_H
dvander@7
    12
#define _INCLUDE_SOURCEMM_H
dvander@7
    13
dvander@7
    14
/**
dvander@7
    15
 * @brief SourceMM main functionality for GameDLL interception
dvander@7
    16
 * @file sourcemm.h
dvander@7
    17
 */
dvander@7
    18
dvander@7
    19
#include <string>
dvander@7
    20
#include <interface.h>
dvander@7
    21
#include <eiface.h>
dvander@7
    22
#include <sourcehook/sourcehook_impl.h>
dvander@7
    23
#include <sourcehook/sourcehook.h>
dvander@7
    24
#include "ISmmAPI.h"
dvander@7
    25
#include "CPlugin.h"
dvander@7
    26
#include "oslink.h"
dvander@7
    27
#include "util.h"
dvander@289
    28
#include "svn_version.h"
dvander@7
    29
dvander@124
    30
/**
dvander@124
    31
 * Versioning
dvander@166
    32
 *   increase api_major when API breaks
dvander@166
    33
 *   increase api_minor when new functions are added (non-breaking)
dvander@124
    34
 */
dvander@289
    35
#define		SOURCEMM_VERSION	SVN_FILE_VERSION_STRING
dvander@7
    36
#define		SOURCEMM_DATE		__DATE__
dvander@124
    37
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
ds@318
    38
#define		SM_VERS_API_MINOR	6		//increase this on a non-breaking API change
dvander@7
    39
ds@318
    40
/* We need a good CServerGameDLL version to work properly.  We support these inclusively. */
dvander@122
    41
#define	MIN_GAMEDLL_VERSION	3
dvander@282
    42
#define	MAX_GAMEDLL_VERSION	8
dvander@122
    43
ds@318
    44
/* Maximum version of IServerPluginCallbacks that SourceMM supports */
ds@318
    45
#define MAX_VSP_VERSION 2
ds@318
    46
dvander@7
    47
/**
dvander@7
    48
 * @brief Entry point for HL2 Engine
dvander@7
    49
 */
dvander@7
    50
SMM_API void *CreateInterface(const char *name, int *code);
dvander@7
    51
dvander@7
    52
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    53
void *EngineFactory(const char *name, int *code);
dvander@7
    54
dvander@7
    55
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    56
void *PhysicsFactory(const char *name, int *code);
dvander@7
    57
dvander@7
    58
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    59
void *FileSystemFactory(const char *name, int *code);
dvander@7
    60
dvander@7
    61
/** @brief Loads all plugins found in a file */
dvander@7
    62
int LoadPluginsFromFile(const char *file);
dvander@7
    63
dvander@7
    64
/** @brief Logs a message to the standard log file */
dvander@7
    65
void LogMessage(const char *msg, ...);
dvander@7
    66
dvander@7
    67
/** @brief Stores information about the GameDLL */
dvander@7
    68
struct GameDllInfo
dvander@7
    69
{
dvander@7
    70
	bool loaded;
dvander@7
    71
	HINSTANCE lib;
dvander@7
    72
	CreateInterfaceFn factory;
dvander@122
    73
	IServerGameDLL *pGameDLL;
ds@192
    74
	IServerGameClients *pGameClients;
dvander@7
    75
};
dvander@7
    76
dvander@7
    77
/** @brief Stores information about the HL2 Engine pointers */
dvander@7
    78
struct EngineInfo
dvander@7
    79
{
dvander@122
    80
	EngineInfo() : loaded(false), 
dvander@122
    81
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@122
    82
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@122
    83
	{ };
dvander@122
    84
	bool loaded;
dvander@7
    85
	CreateInterfaceFn engineFactory;
dvander@7
    86
	CreateInterfaceFn physicsFactory;
dvander@7
    87
	CreateInterfaceFn fileSystemFactory;
dvander@7
    88
	CGlobalVars *pGlobals;
dvander@7
    89
	ICvar *icvar;
dvander@7
    90
	IVEngineServer *engine;
dvander@7
    91
};
dvander@7
    92
dvander@7
    93
/** @brief Global variable for GameDLL info */
dvander@7
    94
extern GameDllInfo g_GameDll;
dvander@7
    95
dvander@7
    96
/** @brief Global variable for Engine info */
dvander@7
    97
extern EngineInfo g_Engine;
dvander@7
    98
dvander@7
    99
/** @brief Global singleton for SourceHook */
dvander@7
   100
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@7
   101
dvander@7
   102
/** @brief Mod path (important!)*/
dvander@98
   103
extern SourceHook::String g_ModPath;
dvander@7
   104
dvander@7
   105
/** @brief Path to server binary */
dvander@98
   106
extern SourceHook::String g_BinPath;
dvander@7
   107
ds@314
   108
/** @brief Path to SourceMM binary */
ds@314
   109
extern SourceHook::String g_SmmPath;
ds@314
   110
dvander@12
   111
/** @brief Global variable for SourceHook macros */
dvander@12
   112
extern SourceHook::ISourceHook *g_SHPtr;
dvander@12
   113
dvander@12
   114
/** @brief We have our own internal plugin id... */
dvander@12
   115
extern PluginId g_PLID;
dvander@12
   116
ds@216
   117
/** @brief ServerGameDLL version that is currently loaded */
ds@216
   118
extern int g_GameDllVersion;
ds@216
   119
ds@318
   120
/** @brief Highest IServerPluginCallbacks version that is supported by engine */
ds@318
   121
extern int g_VspVersion;
ds@318
   122
dvander@340
   123
/** @brief IServerGameClients version the mod uses */
dvander@340
   124
extern int g_GameClientsVersion;
dvander@340
   125
dvander@282
   126
extern bool bGameInit;
dvander@282
   127
dvander@7
   128
#endif //_INCLUDE_SOURCEMM_H