sourcemm/ISmmAPI.h
author David Anderson <dvander@alliedmods.net>
Fri Sep 21 18:03:57 2007 +0000 (2007-09-21)
branchsourcemm-1.6.0
changeset 351 7347be0355ae
parent 348 716af2e7be78
child 352 7d8c71df909f
permissions -rw-r--r--
- added an api call for finding source engine build
- random markup/doc changes
dvander@347
     1
/* ======== SourceMM ========
dvander@347
     2
* Copyright (C) 2004-2007 Metamod:Source Development Team
dvander@347
     3
* No warranties of any kind
dvander@347
     4
*
dvander@347
     5
* License: zlib/libpng
dvander@347
     6
*
dvander@347
     7
* Author(s): David "BAILOPAN" Anderson
dvander@347
     8
* ============================
dvander@347
     9
*/
dvander@347
    10
dvander@347
    11
#ifndef _INCLUDE_ISMM_API_H
dvander@347
    12
#define _INCLUDE_ISMM_API_H
dvander@347
    13
dvander@347
    14
/**
dvander@347
    15
 * @brief External API interface
dvander@347
    16
 * @file ISmmAPI.h
dvander@347
    17
 */
dvander@347
    18
dvander@347
    19
#include <interface.h>
dvander@347
    20
#include <eiface.h>
dvander@347
    21
#include <sourcehook/sourcehook.h>
dvander@347
    22
#include "IPluginManager.h"
dvander@347
    23
dvander@347
    24
#if defined __GNUC__
dvander@347
    25
#if ((__GNUC__ == 3) && (__GNUC_MINOR__ < 4)) || (__GNUC__ < 3)
dvander@347
    26
#error "You must compile with at least GCC 3.4! If you know what you are doing, you can remove this message."
dvander@347
    27
#endif //version check
dvander@347
    28
#endif //__GNUC__
dvander@347
    29
dvander@347
    30
class IMetamodListener;
dvander@347
    31
class ISmmPluginManager;
dvander@347
    32
class ISmmPlugin;
dvander@347
    33
dvander@347
    34
#define	MMIFACE_SOURCEHOOK		"ISourceHook"			/**< ISourceHook Pointer */
dvander@347
    35
#define	MMIFACE_PLMANAGER		"IPluginManager"		/**< SourceMM Plugin Functions */
dvander@351
    36
#define IFACE_MAXNUM			999						/**< Maximum interface version */
dvander@351
    37
dvander@351
    38
#define SOURCE_ENGINE_ORIGINAL			0				/**< Original Source Engine (used by The Ship) */
dvander@351
    39
#define SOURCE_ENGINE_EPISODEONE		1				/**< Episode 1 Source Engine (second major SDK) */
dvander@351
    40
#define SOURCE_ENGINE_ORANGEBOX			2				/**< Orange Box Source Engine (third major SDK) */
dvander@347
    41
dvander@347
    42
class ISmmAPI
dvander@347
    43
{
dvander@347
    44
public:
dvander@347
    45
	/**
dvander@347
    46
	 * @brief Logs a message through the HL2 log system.
dvander@347
    47
	 * Note: Newlines are appended automatically.
dvander@347
    48
	 *
dvander@347
    49
	 * @param pl			Plugin API pointer (used for tagging message)
dvander@347
    50
	 * @param msg			Formatted string.
dvander@347
    51
	 */
dvander@347
    52
	virtual void LogMsg(ISmmPlugin *pl, const char *msg, ...) =0;
dvander@347
    53
public:
dvander@347
    54
	/**
dvander@347
    55
	 * @brief Returns an interface factory for the HL2 engine.
dvander@347
    56
	 *
dvander@347
    57
	 * @param syn			If syn is true, the synthetic wrapper is returned.  
dvander@347
    58
	 *						If syn is false, the true function is returned.
dvander@347
    59
	 * @return				CreateInterfaceFn function pointer.
dvander@347
    60
	 */
dvander@347
    61
	virtual CreateInterfaceFn engineFactory(bool syn=true) =0;
dvander@347
    62
dvander@347
    63
	/**
dvander@347
    64
	 * @brief Returns an interface factory for the HL2 physics engine.
dvander@347
    65
	 *
dvander@347
    66
	 * @param syn			If syn is true, the synthetic wrapper is returned.  
dvander@347
    67
	 *						If syn is false, the true function is returned.
dvander@347
    68
	 * @return				CreateInterfaceFn function pointer.
dvander@347
    69
	 */
dvander@347
    70
	virtual CreateInterfaceFn physicsFactory(bool syn=true) =0;
dvander@347
    71
dvander@347
    72
	/**
dvander@347
    73
	 * @brief Returns an interface factory for the HL2 file system.
dvander@347
    74
	 *
dvander@347
    75
	 * @param syn			If syn is true, the synthetic wrapper is returned.  
dvander@347
    76
	 *						If syn is false, the true function is returned.
dvander@347
    77
	 * @return				CreateInterfaceFn function pointer.
dvander@347
    78
	 */
dvander@347
    79
	virtual CreateInterfaceFn fileSystemFactory(bool syn=true) =0;
dvander@347
    80
dvander@347
    81
	/**
dvander@347
    82
	 * @brief Returns an interface factory for the GameDLL.
dvander@347
    83
	 *
dvander@347
    84
	 * @param syn			If syn is true, the synthetic wrapper is returned.  
dvander@347
    85
	 *						If syn is false, the true function is returned.
dvander@347
    86
	 * @return				CreateInterfaceFn function pointer.
dvander@347
    87
	 */
dvander@347
    88
	virtual CreateInterfaceFn serverFactory(bool syn=true) =0;
dvander@347
    89
dvander@347
    90
	/**
dvander@347
    91
	 * @brief Returns a CGlobalVars pointer from the HL2 Engine.
dvander@347
    92
	 *
dvander@347
    93
	 * @return				CGlobalVars pointer.
dvander@347
    94
	 */
dvander@347
    95
	virtual CGlobalVars *pGlobals() =0;
dvander@347
    96
dvander@347
    97
	/**
dvander@347
    98
	 * @brief Used with SourceHook, sets teh last meta return value.
dvander@347
    99
	 * Note: Do not call this directly, use the Metamod macros.
dvander@347
   100
	 *
dvander@347
   101
	 * @param res			META_RETURN value to set.
dvander@347
   102
	 */
dvander@347
   103
	virtual void SetLastMetaReturn(META_RES res) =0;
dvander@347
   104
dvander@347
   105
	/**
dvander@347
   106
	 * @brief Used with SourceHook, returns the last meta return value.
dvander@347
   107
	 * Note: This is only valid inside a hook function.
dvander@347
   108
	 *
dvander@347
   109
	 * @return				Last META_RETURN value set by a plugin.
dvander@347
   110
	 */
dvander@347
   111
	virtual META_RES GetLastMetaReturn() =0;
dvander@347
   112
dvander@347
   113
public:		// Added in 1.00-RC2 (0:0)
dvander@347
   114
	/**
dvander@347
   115
	 * @brief Allows access to Metamod's ConCommandBaseAccessor.
dvander@347
   116
	 *
dvander@347
   117
	 * @return				Returns IConCommandBaseAccessor pointer.
dvander@347
   118
	 */
dvander@347
   119
	virtual IConCommandBaseAccessor *GetCvarBaseAccessor() =0;
dvander@347
   120
dvander@347
   121
	/**
dvander@347
   122
	 * @brief Registers a ConCommandBase.
dvander@347
   123
	 *
dvander@347
   124
	 * @param plugin		Parent plugin API pointer.
dvander@347
   125
	 * @param pCommand		ConCommandBase to register.
dvander@351
   126
	 * @return				True if successful, false otherwise.
dvander@347
   127
	 */
dvander@347
   128
	virtual bool RegisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
dvander@347
   129
dvander@347
   130
	/**
dvander@347
   131
	 * @brief Unregisters a ConCommandBase.
dvander@347
   132
	 *
dvander@347
   133
	 * @param plugin		Parent plugin API pointer.
dvander@347
   134
	 * @param pCommand		ConCommandBase to unlink.
dvander@347
   135
	 */
dvander@347
   136
	virtual void UnregisterConCmdBase(ISmmPlugin *plugin, ConCommandBase *pCommand) =0;
dvander@347
   137
	
dvander@347
   138
	/**
dvander@347
   139
	 * @brief Prints an unformatted string to the remote server console.
dvander@351
   140
	 * 
dvander@347
   141
	 * Note: Newlines are not added automatically.
dvander@347
   142
	 *
dvander@347
   143
	 * @param str			Message string.
dvander@347
   144
	 */
dvander@347
   145
	virtual void ConPrint(const char *str) =0;
dvander@347
   146
dvander@347
   147
	/**
dvander@347
   148
	 * @brief Prints a formatted message to the remote server console.  
dvander@351
   149
	 * 
dvander@347
   150
	 * Note: Newlines are not added automatically.
dvander@347
   151
	 *
dvander@347
   152
	 * @param fmt			Formatted message.
dvander@347
   153
	 */
dvander@347
   154
	virtual void ConPrintf(const char *fmt, ...) =0;
dvander@347
   155
dvander@347
   156
public:		// Added in 1.1.0 (1:0)
dvander@347
   157
	/**
dvander@347
   158
	 * @brief Checks if ConPrint/ConPrintf will mirror to rcon.
dvander@347
   159
	 *
dvander@347
   160
	 * @return				True if remote printing available, false otherwise.
dvander@347
   161
	 */
dvander@347
   162
	virtual bool RemotePrintingAvailable() =0;
dvander@347
   163
dvander@347
   164
	/**
dvander@347
   165
	 * @brief Returns the Metamod Version numbers as major version and minor (API) version.
dvander@347
   166
	 * Changes to minor version are guaranteed to be backwards compatible.
dvander@347
   167
	 * Changes to major version are not.
dvander@347
   168
	 * 
dvander@347
   169
	 * @param major			Filled with the major API version number.
dvander@347
   170
	 * @param minor			Filled with the minor API version number.
dvander@347
   171
	 * @param plvers		Filled with the current plugin API version number.
dvander@347
   172
	 * @param plmin			Filled with the minimum plugin API version number supported.
dvander@347
   173
	 */
dvander@347
   174
	virtual void GetApiVersions(int &major, int &minor, int &plvers, int &plmin) =0;
dvander@347
   175
	
dvander@347
   176
	/** 
dvander@347
   177
	 * @brief Returns sourcehook API version and implementation version.
dvander@347
   178
	 *
dvander@347
   179
	 * @param shvers		Filled with the SourceHook API version number.
dvander@347
   180
	 * @param shimpl		Filled with the SourceHook implementation number.
dvander@347
   181
	 */
dvander@347
   182
	virtual void GetShVersions(int &shvers, int &shimpl) =0;
dvander@347
   183
	
dvander@347
   184
	/**
dvander@347
   185
	 * @brief Adds a Metamod listener.
dvander@347
   186
	 *
dvander@347
   187
	 * @param plugin		Plugin interface pointer.
dvander@347
   188
	 * @param pListener		Listener interface pointer to add.
dvander@347
   189
	 */
dvander@347
   190
	virtual void AddListener(ISmmPlugin *plugin, IMetamodListener *pListener) =0;
dvander@347
   191
dvander@347
   192
	/**
dvander@347
   193
	  * @brief Queries the metamod factory
dvander@347
   194
	  *
dvander@347
   195
	  * @param iface		String containing interface name
dvander@347
   196
	  * @param ret			Optional pointer to store return status
dvander@347
   197
	  * @param id			Optional pointer to store id of plugin that overrode interface, 0 if none
dvander@347
   198
	  * @return				Returned pointer
dvander@347
   199
	  */
dvander@347
   200
	virtual void *MetaFactory(const char *iface, int *ret, PluginId *id) =0;
dvander@347
   201
dvander@347
   202
public:		// Added in 1.1.2 (1:1)
dvander@347
   203
	/**
dvander@347
   204
	 * @brief Given a base interface name, such as ServerGameDLL or ServerGameDLL003, 
dvander@347
   205
	 * reformats the string to increase the number, then returns the new number.
dvander@347
   206
	 * This is the base function to InterfaceSearch() and VInterfaceMatch().
dvander@347
   207
	 * 
dvander@347
   208
	 * @param iface			Input/output interface name.  Must be writable.
dvander@347
   209
	 * @param maxlength		Maximum length of iface buffer.  Must be at least strlen(iface)+4 chars.
dvander@347
   210
	 * @return				The newly incremented iface version number.
dvander@347
   211
	 */
dvander@347
   212
	virtual int FormatIface(char iface[], unsigned int maxlength) =0;
dvander@347
   213
dvander@347
   214
public:		// Added in 1.2 (1:2)
dvander@347
   215
	/**
dvander@351
   216
	 * @brief Searches for an interface, eliminating the need to loop through FormatIface().
dvander@347
   217
	 * 
dvander@347
   218
	 * @param fn			InterfaceFactory function.
dvander@347
   219
	 * @param iface			Interface string name.
dvander@347
   220
	 * @param max			Maximum version to look up.
dvander@347
   221
	 * @param ret			Last return code from interface factory function.
dvander@347
   222
	 * @return				Interface pointer, or NULL if not found.
dvander@347
   223
	 */
dvander@347
   224
	virtual void *InterfaceSearch(CreateInterfaceFn fn, const char *iface, int max, int *ret) =0;
dvander@347
   225
dvander@347
   226
	/**
dvander@347
   227
	 * @brief Returns the base directory of the game/server, equivalent to 
dvander@351
   228
	 * IVEngineServer::GetGameDir(), except the path is absolute.
dvander@347
   229
	 *
dvander@347
   230
	 * @return				Static pointer to game's absolute basedir.
dvander@347
   231
	 */
dvander@347
   232
	virtual const char *GetBaseDir() =0;
dvander@347
   233
dvander@347
   234
	/**
dvander@351
   235
	 * @brief Formats a file path to the local OS.  
dvander@351
   236
	 *
dvander@351
   237
	 * Does not include any base directories.  Note that all slashes and black 
dvander@351
   238
	 * slashes are reverted to the local OS's expectancy.
dvander@347
   239
	 *
dvander@347
   240
	 * @param buffer		Destination buffer to store path.
dvander@347
   241
	 * @param len			Maximum length of buffer, including null terminator.
dvander@347
   242
	 * @param fmt			Formatted string.
dvander@347
   243
	 */
dvander@347
   244
	virtual void PathFormat(char *buffer, size_t len, const char *fmt, ...) =0;
dvander@347
   245
dvander@347
   246
public:		// Added in 1.2.2 (1:3)
dvander@347
   247
	/**
dvander@351
   248
	 * @brief Prints text in the specified client's console. Same as 
dvander@351
   249
	 * IVEngineServer::ClientPrintf except that it allows for string formatting.
dvander@347
   250
	 *
dvander@347
   251
	 * @param client		Client edict pointer.
dvander@347
   252
	 * @param fmt			Formatted string to print to the client.
dvander@347
   253
	 */
dvander@347
   254
	virtual void ClientConPrintf(edict_t *client, const char *fmt, ...) =0;
dvander@347
   255
dvander@347
   256
public:		// Added in 1.3 (1:4)
dvander@347
   257
	/**
dvander@347
   258
	 * @brief Wrapper around InterfaceSearch().  Assumes no maximum.
dvander@347
   259
	 * This is designed to replace the fact that searches only went upwards.
dvander@347
   260
	 * The "V" is intended to convey that this is for Valve formatted interface strings.
dvander@347
   261
	 *
dvander@347
   262
	 * @param fn			Interface factory function.
dvander@347
   263
	 * @param iface			Interface string.
dvander@351
   264
	 * @param min			Minimum value to search from.  If zero, searching 
dvander@351
   265
	 *						begins from the first available version regardless 
dvander@351
   266
	 *						of the interface.  Note that this can return 
dvander@351
   267
	 *						interfaces EARLIER than the version specified.  A 
dvander@351
   268
	 *						value of -1 (default) specifies the string version 
dvander@351
   269
	 *						as the minimum.  Any other value specifices the 
dvander@351
   270
	 *						minimum value to search from.
dvander@347
   271
	 * @return				Interface pointer, or NULL if not found.
dvander@347
   272
	 */
dvander@347
   273
	virtual void *VInterfaceMatch(CreateInterfaceFn fn, const char *iface, int min=-1) =0;
dvander@347
   274
dvander@347
   275
public:		// Added in 1.4 (1:5)
dvander@347
   276
	/**
dvander@347
   277
	 * @brief Tells SourceMM to add VSP hooking capability to plugins.  
dvander@347
   278
	 *
dvander@351
   279
	 * Since this  potentially uses more resources than it would otherwise, 
dvander@351
   280
	 * plugins have to explicitly enable the feature.  Whether requested or 
dvander@351
   281
	 * not, if it is enabled, all plugins will get a pointer to the VSP 
dvander@351
   282
	 * listener through IMetamodListener.  This will not be called more than 
dvander@351
   283
	 * once for a given plugin; if it is requested more than once, each 
dvander@351
   284
	 * successive call will only give the pointer to plugins which have not 
dvander@351
   285
	 * yet received it.
dvander@347
   286
	 */
dvander@347
   287
	virtual void EnableVSPListener() =0;
dvander@347
   288
dvander@347
   289
	/**
dvander@351
   290
	 * @brief Returns the interface version of the GameDLL's IServerGameDLL 
dvander@351
   291
	 * implementation.
dvander@347
   292
	 *
dvander@347
   293
	 * @return				Interface version of the loaded IServerGameDLL.
dvander@347
   294
	 */
dvander@347
   295
	virtual int GetGameDLLVersion() =0;
dvander@347
   296
dvander@347
   297
	/**
dvander@347
   298
	 * @brief Returns the number of user messages in the GameDLL.
dvander@347
   299
	 *
dvander@351
   300
	 * @return				Number of user messages, or -1 if SourceMM has 
dvander@351
   301
	 *						failed to get user message list.
dvander@347
   302
	 */
dvander@347
   303
	virtual int GetUserMessageCount() =0;
dvander@347
   304
dvander@347
   305
	/**
dvander@347
   306
	 * @brief Returns the index of the specified user message.
dvander@347
   307
	 *
dvander@347
   308
	 * @param name			User message name.
dvander@347
   309
	 * @param size			Optional pointer to store size of user message.
dvander@347
   310
	 * @return				Message index, or -1 on failure.
dvander@347
   311
	 */
dvander@347
   312
	virtual int FindUserMessage(const char *name, int *size=NULL) =0;
dvander@347
   313
dvander@347
   314
	/**
dvander@347
   315
	 * @brief Returns the name of the specified user message.
dvander@347
   316
	 *
dvander@347
   317
	 * @param index			User message index.
dvander@347
   318
	 * @param size			Optional pointer to store size of user message.
dvander@347
   319
	 * @return				Message name, or NULL on failure.
dvander@347
   320
	 */
dvander@347
   321
	virtual const char *GetUserMessage(int index, int *size=NULL) =0;
dvander@351
   322
dvander@348
   323
public:		// Added in 1.5.0 (1:6)
dvander@348
   324
	/**
dvander@351
   325
	 * @brief Returns the highest interface version of IServerPluginCallbacks 
dvander@351
   326
	 * that the engine supports.  This is useful for games that run on older 
dvander@351
   327
	 * versions of the Source engine, such as The Ship.
dvander@348
   328
	 *
dvander@348
   329
	 * @return				Highest interface version of IServerPluginCallbacks.
dvander@351
   330
	 *						Returns 0 if SourceMM's VSP listener isn't currently 
dvander@351
   331
	 *						enabled.
dvander@348
   332
	 */
dvander@348
   333
	virtual int GetVSPVersion() =0;
dvander@351
   334
dvander@351
   335
public:		// Added in 1.6.0 (1:7)
dvander@351
   336
	/**
dvander@351
   337
	 * @brief Returns the engine interface that MM:S is using as a backend.
dvander@351
   338
	 *
dvander@351
   339
	 * The values will be one of the SOURCE_ENGINE_* constants from the top
dvander@351
   340
	 * of this file.
dvander@351
   341
	 *
dvander@351
   342
	 * @return				A SOURCE_ENGINE_* constant value.
dvander@351
   343
	 */
dvander@351
   344
	virtual int GetSourceEngineBuild() =0;
dvander@347
   345
};
dvander@347
   346
dvander@347
   347
dvander@347
   348
/** 
dvander@347
   349
 * Version History
dvander@347
   350
 *
dvander@347
   351
 * 1.1.0 Bumped API to 1:0. The breaking changes occurred in SourceHook and the plugin API.
dvander@347
   352
 * 1.1.2 Added API call for generating iface names.
dvander@347
   353
 * 1.2   Added API more helper functions and new SourceHook version.
dvander@347
   354
 * 1.2.2 Added API for printing to client console (with string formatting).
dvander@347
   355
 * 1.3   Added new interface search API.
dvander@347
   356
 * 1.4	 Added VSP listener and user message API.
dvander@348
   357
 * 1.5.0 Added API for getting highest supported version of IServerPluginCallbacks.
dvander@351
   358
 * 1.6.0 Added API for Orange Box.
dvander@347
   359
 */
dvander@347
   360
dvander@347
   361
#endif //_INCLUDE_ISMM_API_H