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