darope@0: // vi: set ts=4 sw=4 : darope@0: // vim: set tw=75 : darope@0: darope@0: // meta_api.cpp - minimal implementation of metamod's plugin interface darope@0: darope@0: // This is intended to illustrate the (more or less) bare minimum code darope@0: // required for a valid metamod plugin, and is targeted at those who want darope@0: // to port existing HL/SDK DLL code to run as a metamod plugin. darope@0: darope@0: /* darope@0: * Copyright (c) 2001-2003 Will Day darope@0: * darope@0: * This file is part of Metamod. darope@0: * darope@0: * Metamod is free software; you can redistribute it and/or modify it darope@0: * under the terms of the GNU General Public License as published by the darope@0: * Free Software Foundation; either version 2 of the License, or (at darope@0: * your option) any later version. darope@0: * darope@0: * Metamod is distributed in the hope that it will be useful, but darope@0: * WITHOUT ANY WARRANTY; without even the implied warranty of darope@0: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU darope@0: * General Public License for more details. darope@0: * darope@0: * You should have received a copy of the GNU General Public License darope@0: * along with Metamod; if not, write to the Free Software Foundation, darope@0: * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA darope@0: * darope@0: * In addition, as a special exception, the author gives permission to darope@0: * link the code of this program with the Half-Life Game Engine ("HL darope@0: * Engine") and Modified Game Libraries ("MODs") developed by Valve, darope@0: * L.L.C ("Valve"). You must obey the GNU General Public License in all darope@0: * respects for all of the code used other than the HL Engine and MODs darope@0: * from Valve. If you modify this file, you may extend this exception darope@0: * to your version of the file, but you are not obligated to do so. If darope@0: * you do not wish to do so, delete this exception statement from your darope@0: * version. darope@0: * darope@0: */ darope@0: darope@0: #include // always darope@0: darope@0: #include // of course darope@0: darope@0: #include "sdk_util.h" // UTIL_LogPrintf, etc darope@0: darope@0: // Must provide at least one of these.. darope@0: static META_FUNCTIONS gMetaFunctionTable = { darope@0: NULL, // pfnGetEntityAPI HL SDK; called before game DLL darope@0: NULL, // pfnGetEntityAPI_Post META; called after game DLL darope@0: GetEntityAPI2, // pfnGetEntityAPI2 HL SDK2; called before game DLL darope@0: NULL, // pfnGetEntityAPI2_Post META; called after game DLL darope@0: NULL, // pfnGetNewDLLFunctions HL SDK2; called before game DLL darope@0: NULL, // pfnGetNewDLLFunctions_Post META; called after game DLL darope@0: GetEngineFunctions, // pfnGetEngineFunctions META; called before HL engine darope@0: NULL, // pfnGetEngineFunctions_Post META; called after HL engine darope@0: }; darope@0: darope@0: // Description of plugin darope@0: plugin_info_t Plugin_info = { darope@0: META_INTERFACE_VERSION, // ifvers darope@0: "minimal stub", // name darope@0: "1.17", // version darope@0: "2003/11/15", // date darope@0: "Will Day ", // author darope@0: "http://www.metamod.org/", // url darope@0: "STUB", // logtag, all caps please darope@0: PT_ANYTIME, // (when) loadable darope@0: PT_ANYPAUSE, // (when) unloadable darope@0: }; darope@0: darope@0: // Global vars from metamod: darope@0: meta_globals_t *gpMetaGlobals; // metamod globals darope@0: gamedll_funcs_t *gpGamedllFuncs; // gameDLL function tables darope@0: mutil_funcs_t *gpMetaUtilFuncs; // metamod utility functions darope@0: darope@0: // Metamod requesting info about this plugin: darope@0: // ifvers (given) interface_version metamod is using darope@0: // pPlugInfo (requested) struct with info about plugin darope@0: // pMetaUtilFuncs (given) table of utility functions provided by metamod ds@265: C_DLLEXPORT int Meta_Query(const char * /*ifvers */, plugin_info_t **pPlugInfo, darope@0: mutil_funcs_t *pMetaUtilFuncs) darope@0: { darope@0: // Give metamod our plugin_info struct darope@0: *pPlugInfo=&Plugin_info; darope@0: // Get metamod utility function table. darope@0: gpMetaUtilFuncs=pMetaUtilFuncs; darope@0: return(TRUE); darope@0: } darope@0: darope@0: // Metamod attaching plugin to the server. darope@0: // now (given) current phase, ie during map, during changelevel, or at startup darope@0: // pFunctionTable (requested) table of function tables this plugin catches darope@0: // pMGlobals (given) global vars from metamod darope@0: // pGamedllFuncs (given) copy of function tables from game dll darope@0: C_DLLEXPORT int Meta_Attach(PLUG_LOADTIME /* now */, darope@0: META_FUNCTIONS *pFunctionTable, meta_globals_t *pMGlobals, darope@0: gamedll_funcs_t *pGamedllFuncs) darope@0: { darope@0: if(!pMGlobals) { darope@0: LOG_ERROR(PLID, "Meta_Attach called with null pMGlobals"); darope@0: return(FALSE); darope@0: } darope@0: gpMetaGlobals=pMGlobals; darope@0: if(!pFunctionTable) { darope@0: LOG_ERROR(PLID, "Meta_Attach called with null pFunctionTable"); darope@0: return(FALSE); darope@0: } darope@0: memcpy(pFunctionTable, &gMetaFunctionTable, sizeof(META_FUNCTIONS)); darope@0: gpGamedllFuncs=pGamedllFuncs; darope@0: return(TRUE); darope@0: } darope@0: darope@0: // Metamod detaching plugin from the server. darope@0: // now (given) current phase, ie during map, etc darope@0: // reason (given) why detaching (refresh, console unload, forced unload, etc) darope@0: C_DLLEXPORT int Meta_Detach(PLUG_LOADTIME /* now */, darope@0: PL_UNLOAD_REASON /* reason */) darope@0: { darope@0: return(TRUE); darope@0: }