sourcemm/sourcemm.h
author Scott Ehlert <ds@alliedmods.net>
Wed Feb 21 01:51:54 2007 +0000 (2007-02-21)
changeset 287 0492209c065f
parent 282 7a237e9ea5a1
child 289 0e6600d612be
permissions -rw-r--r--
Added experimental user message API functions that don't error out on invalid indices

Added user message list to 'meta game' command

Terrible, ugly code...
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@7
    28
dvander@124
    29
/**
dvander@124
    30
 * Versioning
dvander@166
    31
 *   increase api_major when API breaks
dvander@166
    32
 *   increase api_minor when new functions are added (non-breaking)
dvander@124
    33
 */
dvander@282
    34
#define		SOURCEMM_VERSION	"1.4"
dvander@7
    35
#define		SOURCEMM_DATE		__DATE__
dvander@124
    36
#define		SM_VERS_API_MAJOR	1		//increase this on a breaking change
dvander@282
    37
#define		SM_VERS_API_MINOR	5		//increase this on a non-breaking API change
dvander@7
    38
dvander@124
    39
//We need a good CServerGameDLL version to work properly.  We support these inclusively.
dvander@122
    40
#define	MIN_GAMEDLL_VERSION	3
dvander@282
    41
#define	MAX_GAMEDLL_VERSION	8
dvander@122
    42
dvander@7
    43
/**
dvander@7
    44
 * @brief Entry point for HL2 Engine
dvander@7
    45
 */
dvander@7
    46
SMM_API void *CreateInterface(const char *name, int *code);
dvander@7
    47
dvander@7
    48
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    49
void *EngineFactory(const char *name, int *code);
dvander@7
    50
dvander@7
    51
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    52
void *PhysicsFactory(const char *name, int *code);
dvander@7
    53
dvander@7
    54
/** @brief Wrapper to catch GameDLL calls */
dvander@7
    55
void *FileSystemFactory(const char *name, int *code);
dvander@7
    56
dvander@7
    57
/** @brief Loads all plugins found in a file */
dvander@7
    58
int LoadPluginsFromFile(const char *file);
dvander@7
    59
dvander@7
    60
/** @brief Logs a message to the standard log file */
dvander@7
    61
void LogMessage(const char *msg, ...);
dvander@7
    62
dvander@7
    63
/** @brief Stores information about the GameDLL */
dvander@7
    64
struct GameDllInfo
dvander@7
    65
{
dvander@7
    66
	bool loaded;
dvander@7
    67
	HINSTANCE lib;
dvander@7
    68
	CreateInterfaceFn factory;
dvander@122
    69
	IServerGameDLL *pGameDLL;
ds@192
    70
	IServerGameClients *pGameClients;
dvander@7
    71
};
dvander@7
    72
dvander@7
    73
/** @brief Stores information about the HL2 Engine pointers */
dvander@7
    74
struct EngineInfo
dvander@7
    75
{
dvander@122
    76
	EngineInfo() : loaded(false), 
dvander@122
    77
		engineFactory(NULL), physicsFactory(NULL), fileSystemFactory(NULL),
dvander@122
    78
		pGlobals(NULL), icvar(NULL), engine(NULL)
dvander@122
    79
	{ };
dvander@122
    80
	bool loaded;
dvander@7
    81
	CreateInterfaceFn engineFactory;
dvander@7
    82
	CreateInterfaceFn physicsFactory;
dvander@7
    83
	CreateInterfaceFn fileSystemFactory;
dvander@7
    84
	CGlobalVars *pGlobals;
dvander@7
    85
	ICvar *icvar;
dvander@7
    86
	IVEngineServer *engine;
dvander@7
    87
};
dvander@7
    88
dvander@7
    89
/** @brief Global variable for GameDLL info */
dvander@7
    90
extern GameDllInfo g_GameDll;
dvander@7
    91
dvander@7
    92
/** @brief Global variable for Engine info */
dvander@7
    93
extern EngineInfo g_Engine;
dvander@7
    94
dvander@7
    95
/** @brief Global singleton for SourceHook */
dvander@7
    96
extern SourceHook::CSourceHookImpl g_SourceHook;
dvander@7
    97
dvander@7
    98
/** @brief Mod path (important!)*/
dvander@98
    99
extern SourceHook::String g_ModPath;
dvander@7
   100
dvander@7
   101
/** @brief Path to server binary */
dvander@98
   102
extern SourceHook::String g_BinPath;
dvander@7
   103
dvander@12
   104
/** @brief Global variable for SourceHook macros */
dvander@12
   105
extern SourceHook::ISourceHook *g_SHPtr;
dvander@12
   106
dvander@12
   107
/** @brief We have our own internal plugin id... */
dvander@12
   108
extern PluginId g_PLID;
dvander@12
   109
ds@216
   110
/** @brief ServerGameDLL version that is currently loaded */
ds@216
   111
extern int g_GameDllVersion;
ds@216
   112
dvander@282
   113
extern bool bGameInit;
dvander@282
   114
ds@287
   115
/** @brief Global CallClass for IServerGameDLL */
ds@287
   116
extern SourceHook::CallClass<IServerGameDLL> *g_GameDllPatch;
ds@287
   117
dvander@7
   118
#endif //_INCLUDE_SOURCEMM_H