dvander@9: /* ======== SourceMM ======== dvander@175: * Copyright (C) 2004-2006 Metamod:Source Development Team dvander@9: * No warranties of any kind dvander@9: * dvander@9: * License: zlib/libpng dvander@9: * dvander@9: * Author(s): David "BAILOPAN" Anderson dvander@9: * ============================ dvander@9: */ dvander@9: dvander@7: #ifndef _INCLUDE_ISMM_API_H dvander@7: #define _INCLUDE_ISMM_API_H dvander@7: dvander@9: /** dvander@9: * @brief External API interface dvander@9: * @file ISmmAPI.h dvander@9: */ dvander@9: dvander@7: #include dvander@7: #include dvander@64: #include dvander@7: #include dvander@7: #include "IPluginManager.h" dvander@7: dvander@104: #if defined __GNUC__ dvander@104: #if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3) dvander@109: #error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message." dvander@104: #endif //version check dvander@104: #endif //__GNUC__ dvander@104: dvander@138: class IMetamodListener; dvander@7: class ISmmPluginManager; dvander@7: class ISmmPlugin; dvander@7: dvander@138: #define MMIFACE_SOURCEHOOK "ISourceHook" dvander@138: #define MMIFACE_PLMANAGER "IPluginManager" dvander@138: dvander@7: class ISmmAPI dvander@7: { dvander@7: public: dvander@7: virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0; dvander@7: public: dvander@7: virtual CreateInterfaceFn engineFactory(bool syn=true) =0; dvander@7: virtual CreateInterfaceFn physicsFactory(bool syn=true) =0; dvander@7: virtual CreateInterfaceFn fileSystemFactory(bool syn=true) =0; dvander@7: virtual CreateInterfaceFn serverFactory(bool syn=true) =0; dvander@7: virtual CGlobalVars *pGlobals() =0; dvander@7: virtual void SetLastMetaReturn(META_RES res) =0; dvander@9: virtual META_RES GetLastMetaReturn() =0; dvander@124: public: //Added in 1.00-RC2 (0:0) dvander@124: //solves concommand problems by keeping track for loading/unloading dvander@64: virtual IConCommandBaseAccessor *GetCvarBaseAccessor() =0; dvander@67: virtual bool RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0; dvander@67: virtual void UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0; dvander@124: //attempt fix at valve not exporting rcon printing dvander@76: //these do not add newlines dvander@76: virtual void ConPrint(const char *fmt) =0; dvander@76: virtual void ConPrintf(const char *fmt, ...) =0; dvander@152: public: //Added in 1.1.0 (1:0) dvander@124: //added by request. Checks if ConPrint/ConPrintf will mirror to rcon. dvander@124: virtual bool RemotePrintingAvailable() =0; dvander@124: //Returns the Metamod Version numbers as major version and minor (API) version. dvander@124: //changes to minor version are guaranteed to be backwards compatible. dvander@124: //changes to major version are not. dvander@124: //Also returns current plugin version and minimum plugin version dvander@124: virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0; dvander@124: //Returns sourcehook API version and implementation version dvander@124: virtual void GetShVersions(int &shvers, int &shimpl) =0; dvander@138: //Binds an event listener to your plugin dvander@138: virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0; dvander@139: /** dvander@139: * @brief Queries the metamod factory dvander@139: * dvander@139: * @param iface String containing interface name dvander@139: * @param ret Optional pointer to store return status dvander@139: * @param id Optional pointer to store id of plugin that overrode interface, 0 if none dvander@139: * @return Returned pointer dvander@139: */ dvander@139: virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0; dvander@152: public: //Added in 1.1.2 (1:1) dvander@152: /** dvander@152: * @brief Given a base interface name, such as ServerGameDLL or ServerGameDLL003, dvander@152: * reformats the string to increase the number, then returns the new number. dvander@152: */ dvander@152: virtual int FormatIface(char iface[], unsigned int maxlength) =0; dvander@166: public: //Added in 1.2 (1:2) dvander@166: /** dvander@166: * @brief Searches for an interface for you. dvander@166: */ dvander@166: virtual void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret) =0; dvander@166: dvander@166: /** dvander@166: * @brief Returns the base directory of the game/server, equivalent to IVEngineServer::GetGameDir dvander@166: */ dvander@166: virtual const char *GetBaseDir() =0; dvander@166: dvander@166: /** dvander@166: * @brief Formats a file path to the local OS. Does not include any base directories. dvander@166: */ dvander@166: virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0; dvander@7: }; dvander@7: dvander@138: dvander@124: /** Version history dvander@152: * 1.1.0 bumped API to 1:0. The breaking changes occured in sourcehook and the plugin API. dvander@152: * 1.1.2 added API call for generating iface names. dvander@167: * 1.2 added API more helper functions and new SourceHook version. dvander@124: */ dvander@124: dvander@7: #endif //_INCLUDE_ISMM_API_H