sourcemm/ISmmAPI.h
author Scott Ehlert <ds@alliedmods.net>
Mon Apr 17 19:42:55 2006 +0000 (2006-04-17)
changeset 187 d81c2fc9a708
parent 175 b497b7777f6b
child 192 47649a1d49e3
permissions -rw-r--r--
Fixed a warning in stub and sample :|
dvander@9
     1
/* ======== SourceMM ========
dvander@175
     2
* Copyright (C) 2004-2006 Metamod:Source Development Team
dvander@9
     3
* No warranties of any kind
dvander@9
     4
*
dvander@9
     5
* License: zlib/libpng
dvander@9
     6
*
dvander@9
     7
* Author(s): David "BAILOPAN" Anderson
dvander@9
     8
* ============================
dvander@9
     9
*/
dvander@9
    10
dvander@7
    11
#ifndef _INCLUDE_ISMM_API_H
dvander@7
    12
#define _INCLUDE_ISMM_API_H
dvander@7
    13
dvander@9
    14
/**
dvander@9
    15
 * @brief External API interface
dvander@9
    16
 * @file ISmmAPI.h
dvander@9
    17
 */
dvander@9
    18
dvander@7
    19
#include <interface.h>
dvander@7
    20
#include <eiface.h>
dvander@64
    21
#include <convar.h>
dvander@7
    22
#include <sourcehook/sourcehook.h>
dvander@7
    23
#include "IPluginManager.h"
dvander@7
    24
dvander@104
    25
#if defined __GNUC__
dvander@104
    26
#if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
dvander@109
    27
#error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
dvander@104
    28
#endif //version check
dvander@104
    29
#endif //__GNUC__
dvander@104
    30
dvander@138
    31
class IMetamodListener;
dvander@7
    32
class ISmmPluginManager;
dvander@7
    33
class ISmmPlugin;
dvander@7
    34
dvander@138
    35
#define	MMIFACE_SOURCEHOOK		"ISourceHook"
dvander@138
    36
#define	MMIFACE_PLMANAGER		"IPluginManager"	
dvander@138
    37
dvander@7
    38
class ISmmAPI
dvander@7
    39
{
dvander@7
    40
public:
dvander@7
    41
	virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0;
dvander@7
    42
public:
dvander@7
    43
	virtual CreateInterfaceFn engineFactory(bool syn=true) =0;
dvander@7
    44
	virtual CreateInterfaceFn physicsFactory(bool syn=true) =0;
dvander@7
    45
	virtual CreateInterfaceFn fileSystemFactory(bool syn=true) =0;
dvander@7
    46
	virtual CreateInterfaceFn serverFactory(bool syn=true) =0;
dvander@7
    47
	virtual CGlobalVars *pGlobals() =0;
dvander@7
    48
	virtual void SetLastMetaReturn(META_RES res) =0;
dvander@9
    49
	virtual META_RES GetLastMetaReturn() =0;
dvander@124
    50
public:		//Added in 1.00-RC2 (0:0)
dvander@124
    51
	//solves concommand problems by keeping track for loading/unloading
dvander@64
    52
	virtual IConCommandBaseAccessor *GetCvarBaseAccessor() =0;
dvander@67
    53
	virtual bool RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
dvander@67
    54
	virtual void UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
dvander@124
    55
	//attempt fix at valve not exporting rcon printing
dvander@76
    56
	//these do not add newlines
dvander@76
    57
	virtual void ConPrint(const char *fmt) =0;
dvander@76
    58
	virtual void ConPrintf(const char *fmt, ...) =0;
dvander@152
    59
public:		//Added in 1.1.0 (1:0)
dvander@124
    60
	//added by request.  Checks if ConPrint/ConPrintf will mirror to rcon.
dvander@124
    61
	virtual bool RemotePrintingAvailable() =0;
dvander@124
    62
	//Returns the Metamod Version numbers as major version and minor (API) version.
dvander@124
    63
	//changes to minor version are guaranteed to be backwards compatible.
dvander@124
    64
	//changes to major version are not.
dvander@124
    65
	//Also returns current plugin version and minimum plugin version
dvander@124
    66
	virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
dvander@124
    67
	//Returns sourcehook API version and implementation version
dvander@124
    68
	virtual void GetShVersions(int &shvers, int &shimpl) =0;
dvander@138
    69
	//Binds an event listener to your plugin
dvander@138
    70
	virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0;
dvander@139
    71
	/**
dvander@139
    72
	  * @brief Queries the metamod factory
dvander@139
    73
	  *
dvander@139
    74
	  * @param iface	String containing interface name
dvander@139
    75
	  * @param ret		Optional pointer to store return status
dvander@139
    76
	  * @param id		Optional pointer to store id of plugin that overrode interface, 0 if none
dvander@139
    77
	  * @return			Returned pointer
dvander@139
    78
	  */
dvander@139
    79
	virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;
dvander@152
    80
public:		//Added in 1.1.2 (1:1)
dvander@152
    81
	/**
dvander@152
    82
	 * @brief Given a base interface name, such as ServerGameDLL or ServerGameDLL003, 
dvander@152
    83
	 * reformats the string to increase the number, then returns the new number.
dvander@152
    84
	 */
dvander@152
    85
	virtual int FormatIface(char iface[], unsigned int maxlength) =0;
dvander@166
    86
public:		//Added in 1.2 (1:2)
dvander@166
    87
	/**
dvander@166
    88
	 * @brief Searches for an interface for you.
dvander@166
    89
	 */
dvander@166
    90
	virtual void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret) =0;
dvander@166
    91
dvander@166
    92
	/**
dvander@166
    93
	 * @brief Returns the base directory of the game/server, equivalent to IVEngineServer::GetGameDir
dvander@166
    94
	 */
dvander@166
    95
	virtual const char *GetBaseDir() =0;
dvander@166
    96
dvander@166
    97
	/**
dvander@166
    98
	 * @brief Formats a file path to the local OS.  Does not include any base directories.
dvander@166
    99
	 */
dvander@166
   100
	virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;
dvander@7
   101
};
dvander@7
   102
dvander@138
   103
dvander@124
   104
/** Version history
dvander@152
   105
 * 1.1.0 bumped API to 1:0.  The breaking changes occured in sourcehook and the plugin API.
dvander@152
   106
 * 1.1.2 added API call for generating iface names.
dvander@167
   107
 * 1.2   added API more helper functions and new SourceHook version.
dvander@124
   108
 */
dvander@124
   109
dvander@7
   110
#endif //_INCLUDE_ISMM_API_H