ISmmAPI.h

Go to the documentation of this file.

/*
 * vim: set ts=4 :
 * ======================================================
 * Metamod:Source
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
 * All rights reserved.
 * ======================================================
 *
 * This software is provided 'as-is', without any express or implied warranty.
 * In no event will the authors be held liable for any damages arising from 
 * the use of this software.
 * 
 * Permission is granted to anyone to use this software for any purpose, 
 * including commercial applications, and to alter it and redistribute it 
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not 
 * claim that you wrote the original software. If you use this software in a 
 * product, an acknowledgment in the product documentation would be 
 * appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 *
 * Version: $Id: ISmmAPI.h 581 2007-11-26 14:03:25Z pm $
 */

#ifndef _INCLUDE_ISMM_API_H
#define _INCLUDE_ISMM_API_H

#include <stdarg.h>
#include <interface.h>
#include <eiface.h>
#include <sourcehook.h>
#include <IPluginManager.h>
#include <ISmmPlugin.h>
#include <ISmmPluginExt.h>

#if defined __GNUC__
#if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
#error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
#endif //version check
#endif //__GNUC__

#define MMIFACE_SOURCEHOOK              "ISourceHook"                   
#define MMIFACE_PLMANAGER               "IPluginManager"                
#define MMIFACE_SH_HOOKMANAUTOGEN       "IHookManagerAutoGen"           
#define IFACE_MAXNUM                    999                                             
namespace SourceMM
{
        class ISmmPlugin;
        class IMetamodListener;

        class ISmmAPI
        {
        public:
                virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0;
        
                virtual CreateInterfaceFn GetEngineFactory(bool syn=true) =0;

                virtual CreateInterfaceFn GetPhysicsFactory(bool syn=true) =0;

                virtual CreateInterfaceFn GetFileSystemFactory(bool syn=true) =0;

                virtual CreateInterfaceFn GetServerFactory(bool syn=true) =0;

                virtual CGlobalVars *GetCGlobals() =0;

                virtual bool RegisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;

                virtual void UnregisterConCommandBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
        
                virtual void ConPrint(const char *str) =0;

                virtual void ConPrintf(const char *fmt, ...) =0;

                virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
        
                virtual void GetShVersions(int &shvers, int &shimpl) =0;
        
                virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0;

                virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;

                virtual int FormatIface(char iface[], unsigned int maxlength) =0;

                virtual void *InterfaceSearch(CreateInterfaceFn fn, 
                                                                          const char *iface, 
                                                                          int max, 
                                                                          int *ret) =0;

                virtual const char *GetBaseDir() =0;

                virtual size_t PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;

                virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0;

                virtual void *VInterfaceMatch(CreateInterfaceFn fn, 
                                                                          const char *iface, 
                                                                          int min=-1) =0;

                virtual void EnableVSPListener() =0;

                virtual int GetGameDLLVersion() =0;

                virtual int GetUserMessageCount() =0;

                virtual int FindUserMessage(const char *name, int *size=NULL) =0;

                virtual const char *GetUserMessage(int index, int *size=NULL) =0;

                virtual int GetVSPVersion() =0;

                virtual int GetSourceEngineBuild() =0;

                virtual IServerPluginCallbacks *GetVSPInfo(int *pVersion) =0;

        virtual size_t Format(char *buffer, 
                                                  size_t maxlength,
                                                  const char *format,
                                                  ...) =0;

                virtual size_t FormatArgs(char *buffer,
                                                                  size_t maxlength,
                                                                  const char *format,
                                                                  va_list ap) =0;
        };
}

#if !defined METAMOD_NO_AUTO_NAMESPACE
using namespace SourceMM;
#endif

#endif //_INCLUDE_ISMM_API_H

---