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@244: #define MMIFACE_PLMANAGER "IPluginManager" dvander@244: #define IFACE_MAXNUM 999 dvander@138: dvander@7: class ISmmAPI dvander@7: { dvander@7: public: dvander@244: /** dvander@244: * @brief Logs a message through the HL2 log system. dvander@244: * Note: Newlines are appended automatically. dvander@244: * dvander@244: * @param pl Plugin API pointer (used for tagging message) dvander@244: * @param msg Formatted string. dvander@244: */ dvander@7: virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0; dvander@7: public: dvander@244: /** dvander@244: * @brief Returns an interface factory for the HL2 engine. dvander@244: * dvander@244: * @param syn If syn is true, the synthetic wrapper is returned. dvander@244: * If syn is false, the true function is returned. dvander@244: * @return CreateInterfaceFn function pointer. dvander@244: */ dvander@7: virtual CreateInterfaceFn engineFactory(bool syn=true) =0; dvander@244: dvander@244: /** dvander@244: * @brief Returns an interface factory for the HL2 physics engine. dvander@244: * dvander@244: * @param syn If syn is true, the synthetic wrapper is returned. dvander@244: * If syn is false, the true function is returned. dvander@244: * @return CreateInterfaceFn function pointer. dvander@244: */ dvander@7: virtual CreateInterfaceFn physicsFactory(bool syn=true) =0; dvander@244: dvander@244: /** dvander@244: * @brief Returns an interface factory for the HL2 file system. dvander@244: * dvander@244: * @param syn If syn is true, the synthetic wrapper is returned. dvander@244: * If syn is false, the true function is returned. dvander@244: * @return CreateInterfaceFn function pointer. dvander@244: */ dvander@7: virtual CreateInterfaceFn fileSystemFactory(bool syn=true) =0; dvander@244: dvander@244: /** dvander@244: * @brief Returns an interface factory for the GameDLL. dvander@244: * dvander@244: * @param syn If syn is true, the synthetic wrapper is returned. dvander@244: * If syn is false, the true function is returned. dvander@244: * @return CreateInterfaceFn function pointer. dvander@244: */ dvander@7: virtual CreateInterfaceFn serverFactory(bool syn=true) =0; dvander@244: dvander@244: /** dvander@244: * @brief Returns a CGlobalVars pointer from the HL2 Engine. dvander@244: * dvander@244: * @return CGlobalVars pointer. dvander@244: */ dvander@7: virtual CGlobalVars *pGlobals() =0; dvander@244: dvander@244: /** dvander@244: * @brief Used with SourceHook, sets teh last meta return value. dvander@244: * Note: Do not call this directly, use the Metamod macros. dvander@244: * dvander@244: * @param res META_RETURN value to set. dvander@244: */ dvander@7: virtual void SetLastMetaReturn(META_RES res) =0; dvander@244: dvander@244: /** dvander@244: * @brief Used with SourceHook, returns the last meta return value. dvander@244: * Note: This is only valid inside a hook function. dvander@244: * dvander@244: * @return Last META_RETURN value set by a plugin. dvander@244: */ dvander@9: virtual META_RES GetLastMetaReturn() =0; dvander@244: dvander@124: public: //Added in 1.00-RC2 (0:0) dvander@244: /** dvander@244: * @brief Allows access to Metamod's ConCommandBaseAccessor. dvander@244: * dvander@244: * @return Returns IConCommandBaseAccessor pointer. dvander@244: */ dvander@64: virtual IConCommandBaseAccessor *GetCvarBaseAccessor() =0; dvander@244: dvander@244: /** dvander@244: * @brief Registers a ConCommandBase. dvander@244: * dvander@244: * @param plugin Parent plugin API pointer. dvander@244: * @param pCommand ConCommandBase to register. dvander@244: * @return True if successful, false otherwise. Does not return false yet. dvander@244: */ dvander@67: virtual bool RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0; dvander@244: dvander@244: /** dvander@244: * @brief Unregisters a ConCommandBase. dvander@244: * dvander@244: * @param plugin Parent plugin API pointer. dvander@244: * @param pCommand ConCommandBase to unlink. dvander@244: */ dvander@67: virtual void UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0; dvander@244: dvander@244: /** dvander@244: * @brief Prints an unformatted string to the remote server console. dvander@244: * Note: Newlines are not added automatically. dvander@244: * dvander@244: * @param str Message string. dvander@244: */ dvander@244: virtual void ConPrint(const char *str) =0; dvander@244: dvander@244: /** dvander@244: * @brief Prints a formatted message to the remote server console. dvander@244: * Note: Newlines are not added automatically. dvander@244: * dvander@244: * @param fmt Formatted message. dvander@244: */ dvander@76: virtual void ConPrintf(const char *fmt, ...) =0; dvander@244: dvander@152: public: //Added in 1.1.0 (1:0) dvander@244: /** dvander@244: * @brief Checks if ConPrint/ConPrintf will mirror to rcon. dvander@244: * dvander@244: * @return True if remote printing available, false otherwise. dvander@244: */ dvander@124: virtual bool RemotePrintingAvailable() =0; dvander@244: dvander@244: /** dvander@244: * @brief Returns the Metamod Version numbers as major version and minor (API) version. dvander@244: * Changes to minor version are guaranteed to be backwards compatible. dvander@244: * Changes to major version are not. dvander@244: * dvander@244: * @param major Filled with the major API version number. dvander@244: * @param minor Filled with the minor API version number. dvander@244: * @param plvers Filled with the current plugin API version number. dvander@244: * @param plmin Filled with the minimum plugin API version number supported. dvander@244: */ dvander@124: virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0; dvander@244: dvander@244: /** dvander@244: * @brief Returns sourcehook API version and implementation version. dvander@244: * dvander@244: * @param shvers Filled with the SourceHook API version number. dvander@244: * @param shimpl Filled with the SourceHook implementation number. dvander@244: */ dvander@124: virtual void GetShVersions(int &shvers, int &shimpl) =0; dvander@244: dvander@244: /** dvander@244: * @brief Adds a Metamod listener. dvander@244: * dvander@244: * @param plugin Plugin interface pointer. dvander@244: * @param pListener Listener interface pointer to add. dvander@244: */ dvander@138: virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0; dvander@244: dvander@139: /** dvander@139: * @brief Queries the metamod factory dvander@139: * dvander@244: * @param iface String containing interface name dvander@244: * @param ret Optional pointer to store return status dvander@244: * @param id Optional pointer to store id of plugin that overrode interface, 0 if none dvander@244: * @return Returned pointer dvander@139: */ dvander@139: virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0; dvander@244: 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@244: * This is the base function to InterfaceSearch() and VInterfaceMatch(). dvander@244: * dvander@244: * @param iface Input/output interface name. Must be writable. dvander@244: * @param maxlength Maximum length of iface buffer. Must be at least strlen(iface)+4 chars. dvander@244: * @return The newly incremented iface version number. dvander@152: */ dvander@152: virtual int FormatIface(char iface[], unsigned int maxlength) =0; dvander@244: dvander@166: public: //Added in 1.2 (1:2) dvander@166: /** dvander@166: * @brief Searches for an interface for you. dvander@244: * dvander@244: * @param fn InterfaceFactory function. dvander@244: * @param iface Interface string name. dvander@244: * @param max Maximum version to look up. dvander@244: * @param ret Last return code from interface factory function. dvander@244: * @return Interface pointer, or NULL if not found. dvander@166: */ dvander@166: virtual void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret) =0; dvander@166: dvander@166: /** dvander@244: * @brief Returns the base directory of the game/server, equivalent to dvander@244: * IVEngineServer::GetGameDir(). dvander@244: * dvander@244: * @return Static pointer to game's basedir. 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@244: * Note that all slashes and black slashes are reverted to the local OS's expectancy. dvander@244: * dvander@244: * @param buffer Destination buffer to store path. dvander@244: * @param len Maximum length of buffer, including null terminator. dvander@244: * @param fmt Formatted string. dvander@166: */ dvander@166: virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0; dvander@244: ds@192: public: // Added in 1.2.2 (1:3) ds@192: /** ds@192: * @brief Prints text in the specified client's console. Same as IVEngineServer::ClientPrintf ds@192: * except that it allows for string formatting. dvander@244: * dvander@244: * @param client Client edict pointer. dvander@244: * @param fmt Formatted string to print to the client. ds@192: */ ds@192: virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0; dvander@244: dvander@244: public: // Added in 1.3 (1:4) dvander@244: /** dvander@244: * @brief Wrapper around InterfaceSearch(). Assumes no maximum. dvander@244: * This is designed to replace the fact that searches only went upwards. dvander@244: * The "V" is intended to convey that this is for Valve formatted interface strings. dvander@244: * dvander@244: * @param fn Interface factory function. dvander@244: * @param iface Interface string. dvander@251: * @param min Minimum value to search from. If zero, searching begins from the dvander@251: * first available version regardless of the interface. dvander@251: * Note that this can return interfaces EARLIER than the version specified. dvander@251: * A value of -1 (default) specifies the string version as the minimum. dvander@251: * Any other value specifices the minimum value to search from. dvander@244: * @return Interface pointer, or NULL if not found. dvander@244: */ dvander@251: virtual void *VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min=-1) =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. ds@192: * 1.2.2 added API for printing to client console (with string formatting) dvander@244: * 1.3 added new interface search API dvander@124: */ dvander@124: dvander@7: #endif //_INCLUDE_ISMM_API_H