sourcemm/sourcemm.h
author Scott Ehlert <ds@alliedmods.net>
Thu Jul 13 06:08:08 2006 +0000 (2006-07-13)
changeset 216 baece18f381f
parent 215 e3b5d251a9dd
child 238 c27105949293
permissions -rw-r--r--
Added some extra information to the "meta game" command: Description and Interface
(This is BAILOPAN's excellent idea!)
dvander@7
     1
/* ======== SourceMM ========
dvander@175
     2
* Copyright (C) 2004-2006 Metamod:Source Development Team
dvander@7
     3
* No warranties of any kind
dvander@7
     4
*
dvander@7
     5
* License: zlib/libpng
dvander@7
     6
*
dvander@7
     7
* Author(s): David "BAILOPAN" Anderson
dvander@7
     8
* ============================
dvander@7
     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@7
    28
dvander@124
    29
/**
dvander@124
    30
 * Versioning
dvander@166
    31
 *   ?what the hell was I smoking when I wrote this
dvander@166
    32
 *   increase api_major when API breaks
dvander@166
    33
 *   increase api_minor when new functions are added (non-breaking)
dvander@166
    34
 *   increase vers_release when bug fix releases are made
dvander@166
    35
 *   never increase major
dvander@124
    36
 */
ds@215
    37
#define		SOURCEMM_VERSION	"1.2.4"
dvander@7
    38
#define		SOURCEMM_DATE		__DATE__
dvander@124
    39
#define		SM_MAJOR_VERSION	1		//never need to increase this
dvander@124
    40
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
ds@192
    41
#define		SM_VERS_API_MINOR	3		//increase this on a non-breaking API change
ds@215
    42
#define		SM_VERS_RELEASE		4		//increase this on a bug-fix release.
dvander@7
    43
dvander@124
    44
//We need a good CServerGameDLL version to work properly.  We support these inclusively.
dvander@122
    45
#define	MIN_GAMEDLL_VERSION	3
ds@213
    46
#define	MAX_GAMEDLL_VERSION	5
dvander@122
    47
dvander@7
    48
/**
dvander@7
    49
 * @brief Entry point for HL2 Engine
dvander@7
    50
 */
dvander@7
    51
SMM_API void *CreateInterface(const char *name, int *code);
dvander@7
    52
dvander@7
    53
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    54
void *EngineFactory(const char *name, int *code);
dvander@7
    55
dvander@7
    56
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    57
void *PhysicsFactory(const char *name, int *code);
dvander@7
    58
dvander@7
    59
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    60
void *FileSystemFactory(const char *name, int *code);
dvander@7
    61
dvander@7
    62
/** @brief Loads all plugins found in a file */
dvander@7
    63
int LoadPluginsFromFile(const char *file);
dvander@7
    64
dvander@7
    65
/** @brief Logs a message to the standard log file */
dvander@7
    66
void LogMessage(const char *msg, ...);
dvander@7
    67
dvander@7
    68
/** @brief Stores information about the GameDLL */
dvander@7
    69
struct GameDllInfo
dvander@7
    70
{
dvander@7
    71
	bool loaded;
dvander@7
    72
	HINSTANCE lib;
dvander@7
    73
	CreateInterfaceFn factory;
dvander@122
    74
	IServerGameDLL *pGameDLL;
ds@192
    75
	IServerGameClients *pGameClients;
dvander@7
    76
};
dvander@7
    77
dvander@7
    78
/** @brief Stores information about the HL2 Engine pointers */
dvander@7
    79
struct EngineInfo
dvander@7
    80
{
dvander@122
    81
	EngineInfo() : loaded(false), 
dvander@122
    82
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@122
    83
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@122
    84
	{ };
dvander@122
    85
	bool loaded;
dvander@7
    86
	CreateInterfaceFn engineFactory;
dvander@7
    87
	CreateInterfaceFn physicsFactory;
dvander@7
    88
	CreateInterfaceFn fileSystemFactory;
dvander@7
    89
	CGlobalVars *pGlobals;
dvander@7
    90
	ICvar *icvar;
dvander@7
    91
	IVEngineServer *engine;
dvander@7
    92
};
dvander@7
    93
dvander@7
    94
/** @brief Global variable for GameDLL info */
dvander@7
    95
extern GameDllInfo g_GameDll;
dvander@7
    96
dvander@7
    97
/** @brief Global variable for Engine info */
dvander@7
    98
extern EngineInfo g_Engine;
dvander@7
    99
dvander@7
   100
/** @brief Global singleton for SourceHook */
dvander@7
   101
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@7
   102
dvander@7
   103
/** @brief Mod path (important!)*/
dvander@98
   104
extern SourceHook::String g_ModPath;
dvander@7
   105
dvander@7
   106
/** @brief Path to server binary */
dvander@98
   107
extern SourceHook::String g_BinPath;
dvander@7
   108
dvander@12
   109
/** @brief Global variable for SourceHook macros */
dvander@12
   110
extern SourceHook::ISourceHook *g_SHPtr;
dvander@12
   111
dvander@12
   112
/** @brief We have our own internal plugin id... */
dvander@12
   113
extern PluginId g_PLID;
dvander@12
   114
ds@216
   115
/** @brief ServerGameDLL version that is currently loaded */
ds@216
   116
extern int g_GameDllVersion;
ds@216
   117
dvander@7
   118
#endif //_INCLUDE_SOURCEMM_H