foxbot/meta_api.cpp at master · APGRoboCop/foxbot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// This is an open source non-commercial project. Dear PVS-Studio, please check it.
// PVS-Studio Static Code Analyzer for C, C++, C#, and Java: http://www.viva64.com
// vi: set ts=4	sw=4 :
// vim:	set	tw=75 :

// meta_api.cpp	- minimal implementation of	metamod's plugin interface

// This	is intended	to illustrate the (more	or less) bare minimum code
// required	for	a valid	metamod	plugin,	and	is targeted	at those who want
// to port existing	HL/SDK DLL code	to run as a	metamod	plugin.

/*
 * Copyright	(c)	2001, Will Day <willday@hpgx.net>
 */

#include "extdll.h"   // always
#include <meta_api.h> // of course

#include "bot.h"

extern bool mr_meta;

// #include "sdk_util.h"		// UTIL_LogPrintf, etc

// Must	provide	at least one of	these..
static META_FUNCTIONS gMetaFunctionTable = {
    GetEntityAPI,            // pfnGetEntityAPI				HL SDK;	called before game DLL
    GetEntityAPI_Post,       // pfnGetEntityAPI_Post			META; called after game	DLL
    nullptr,                 // pfnGetEntityAPI2				HL SDK2; called	before game	DLL
    nullptr,                 // pfnGetEntityAPI2_Post		META; called after game	DLL
    nullptr,                 // pfnGetNewDLLFunctions		HL SDK2; called	before game	DLL
    nullptr,                 // pfnGetNewDLLFunctions_Post	META; called after game	DLL
    GetEngineFunctions,      // pfnGetEngineFunctions		META; called before	HL engine
    GetEngineFunctions_Post, // pfnGetEngineFunctions_Post	META; called after HL engine
};

// Description of plugin
plugin_info_t Plugin_info = {
    META_INTERFACE_VERSION,                        // ifvers
    "FoxBot",                                      // name
    "1.0-beta1",                                       // version
    __DATE__,                                      // date
    "Tom Simpson & RoboCop <robocop@lycos.co.uk>", // author
    "https://apg-clan.org/",                       // url
    //"http://www.omni-bot.com/",	// url
    //"http://www.foxbot.net/",	// url
    "FOXBOT",   // logtag
    PT_STARTUP, // (when) loadable
    PT_STARTUP, // (when) unloadable
};

// Global vars from	metamod:
meta_globals_t *gpMetaGlobals = nullptr;   // metamod globals
gamedll_funcs_t *gpGamedllFuncs = nullptr; // gameDLL function	tables
mutil_funcs_t *gpMetaUtilFuncs = nullptr;  // metamod utility functions

void Meta_Init() { mr_meta = true; }

// Metamod requesting info about this plugin:
//	ifvers			(given)	interface_version metamod is using
//	pPlugInfo		(requested)	struct with	info about plugin
//	pMetaUtilFuncs	(given)	table of utility functions provided	by metamod
C_DLLEXPORT int Meta_Query(char *ifvers, plugin_info_t **pPlugInfo, mutil_funcs_t *pMetaUtilFuncs) {
   // Give metamod our plugin_info struct
   *pPlugInfo = &Plugin_info;
   // Get metamod utility function table.
   gpMetaUtilFuncs = pMetaUtilFuncs;

   // check for interface version compatibility
   // this bit of code was adapted from code by Pierre-Marie Baty
   if (std::strcmp(ifvers, Plugin_info.ifvers) != 0) {
      LOG_CONSOLE(PLID, "%s: meta-interface version mismatch (metamod: %s, %s: %s)", Plugin_info.name, ifvers, Plugin_info.name, Plugin_info.ifvers);
      LOG_MESSAGE(PLID, "%s: meta-interface version mismatch (metamod: %s, %s: %s)", Plugin_info.name, ifvers, Plugin_info.name, Plugin_info.ifvers);
      return 0;
   }
   return 1;
}

// Metamod attaching plugin	to the server.
//	now				(given)	current	phase, ie during map, during changelevel, or at	startup
//	pFunctionTable	(requested)	table of function tables this plugin catches
//	pMGlobals		(given)	global vars	from metamod
//	pGamedllFuncs	(given)	copy of	function tables	from game dll
C_DLLEXPORT int Meta_Attach(const PLUG_LOADTIME now, META_FUNCTIONS *pFunctionTable, meta_globals_t *pMGlobals, gamedll_funcs_t *pGamedllFuncs) {
   if (!pMGlobals) {
      LOG_ERROR(PLID, "Meta_Attach called	with null pMGlobals");
      return 0;
   }
   gpMetaGlobals = pMGlobals;
   if (!pFunctionTable) {
      LOG_ERROR(PLID, "Meta_Attach called	with null pFunctionTable");
      return 0;
   }
   std::memcpy(pFunctionTable, &gMetaFunctionTable, sizeof(META_FUNCTIONS));
   gpGamedllFuncs = pGamedllFuncs;
   return 1;
}

// Metamod detaching plugin	from the server.
// now		(given)	current	phase, ie during map, etc
// reason	(given)	why	detaching (refresh,	console	unload,	forced unload, etc)
C_DLLEXPORT int Meta_Detach(const PLUG_LOADTIME now, const PL_UNLOAD_REASON reason) {
   if (now && reason)
      // to satisfy gcc -Wunused
      return 1;
   return 0;
}