sourcemm/metamod_provider.h
author David Anderson <dvander@alliedmods.net>
Thu Oct 04 19:18:19 2007 +0000 (2007-10-04)
branchsourcemm-1.6.0
changeset 369 2b8c2ea08b6d
parent 367 fc76472b980f
permissions -rw-r--r--
fixed usermessages not printing
removed old ConMsg extraction code
dvander@367
     1
/**
dvander@367
     2
 * vim: set ts=4 :
dvander@367
     3
 * ======================================================
dvander@367
     4
 * Metamod:Source
dvander@367
     5
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
dvander@367
     6
 * All rights reserved.
dvander@367
     7
 * ======================================================
dvander@367
     8
 *
dvander@367
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@367
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@367
    11
 * the use of this software.
dvander@367
    12
 * 
dvander@367
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@367
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@367
    15
 * freely, subject to the following restrictions:
dvander@367
    16
 *
dvander@367
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@367
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@367
    19
 * product, an acknowledgment in the product documentation would be 
dvander@367
    20
 * appreciated but is not required.
dvander@367
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@367
    22
 * misrepresented as being the original software.
dvander@367
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@367
    24
 *
dvander@367
    25
 * Version: $Id$
dvander@367
    26
 */
dvander@367
    27
dvander@353
    28
#ifndef _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@353
    29
#define _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@353
    30
dvander@353
    31
namespace SourceMM
dvander@353
    32
{
dvander@353
    33
	enum
dvander@353
    34
	{
dvander@353
    35
		ConVarFlag_None,
dvander@353
    36
		ConVarFlag_Notify,
dvander@353
    37
		ConVarFlag_Replicated,
dvander@353
    38
		ConVarFlag_SpOnly
dvander@353
    39
	};
dvander@353
    40
dvander@353
    41
	enum ProvidedHooks
dvander@353
    42
	{
dvander@353
    43
		ProvidedHook_LevelInit = 0,			/**< IServerGameDLL::LevelInit */
dvander@353
    44
		ProvidedHook_LevelShutdown = 1,		/**< IServerGameDLL::LevelShutdown */
dvander@353
    45
		ProvidedHook_DLLInit = 2,			/**< IServerGameDLL::DLLInit */
dvander@353
    46
		ProvidedHook_DLLShutdown = 3,		/**< IServerGameDLL::DLLShutdown */
dvander@353
    47
		ProvidedHook_GameInit = 4,			/**< IServerGameDLL::GameInit */
dvander@353
    48
	};
dvander@353
    49
dvander@353
    50
	/**
dvander@353
    51
	 * @brief Abstracts command information, since the new engine fixes the 
dvander@353
    52
	 * re-entrancy problems in the tokenization system.
dvander@353
    53
	 */
dvander@353
    54
	class IMetamodSourceCommandInfo
dvander@353
    55
	{
dvander@353
    56
	public:
dvander@353
    57
		/**
dvander@353
    58
		 * @brief Returns the argument count such that arguments 
dvander@353
    59
		 * 1 to N are valid arguments, and 0 is the command name.
dvander@353
    60
		 *
dvander@353
    61
		 * @return					Argument count.
dvander@353
    62
		 */
dvander@353
    63
		virtual unsigned int GetArgCount() =0;
dvander@353
    64
dvander@353
    65
		/**
dvander@353
    66
		 * @brief Returns the string of an argument number.
dvander@353
    67
		 *
dvander@353
    68
		 * @param num				Argument number.
dvander@353
    69
		 * @return					Argument text.
dvander@353
    70
		 */
dvander@353
    71
		virtual const char *GetArg(unsigned int num) =0;
dvander@353
    72
dvander@353
    73
		/**
dvander@353
    74
		 * @brief Returns the entire command argument string.
dvander@353
    75
		 *
dvander@353
    76
		 * @return					Argument string.
dvander@353
    77
		 */
dvander@353
    78
		virtual const char *GetArgString() =0;
dvander@353
    79
	};
dvander@353
    80
dvander@353
    81
	class IMetamodSourceProvider
dvander@353
    82
	{
dvander@353
    83
	public:
dvander@353
    84
		/**
dvander@353
    85
		 * @brief Returns whether source engine build is compatible.
dvander@353
    86
		 *
dvander@353
    87
		 * @param build				Source engine build.
dvander@353
    88
		 * @return					True if compatible, false otherwise.
dvander@353
    89
		 */
dvander@353
    90
		virtual bool IsSourceEngineBuildCompatible(int build) =0;
dvander@353
    91
dvander@353
    92
		/**
dvander@353
    93
		 * @brief Retrieves hook information for each callback.  Each hook 
dvander@353
    94
		 * must be implemented.
dvander@353
    95
		 *
dvander@353
    96
		 * @param hook				Hook information to provide.
dvander@353
    97
		 * @param pInfo				Non-NULL pointer to fill with information 
dvander@353
    98
		 * 							about the hook's virtual location.
dvander@353
    99
		 * @return					True if supported, false to fail, which 
dvander@353
   100
		 * 							will cause Metamod:Source to fail.
dvander@353
   101
		 */
dvander@353
   102
		virtual bool GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) =0;
dvander@353
   103
dvander@353
   104
		/**
dvander@353
   105
		 * @brief Logs a message via IVEngineServer::LogPrint.
dvander@353
   106
		 * 
dvander@353
   107
		 * @param buffer			Buffer to print.
dvander@353
   108
		 * @return					True on success, false if not supported, 
dvander@353
   109
		 * 							or IVEngineServer is not yet known.
dvander@353
   110
		 */
dvander@353
   111
		virtual bool LogMessage(const char *buffer) =0;
dvander@353
   112
dvander@353
   113
		/**
dvander@353
   114
		 * @brief Returns the command line value of a parameter.  If ICvar 
dvander@353
   115
		 * is not yet loaded, this uses an equivalent function.
dvander@353
   116
		 *
dvander@353
   117
		 * @param key				Parameter to look up.
dvander@353
   118
		 * @param val				Default string to return if none found.
dvander@353
   119
		 * @return					Parameter value.
dvander@353
   120
		 */
dvander@353
   121
		virtual const char *GetCommandLineValue(const char *key, const char *defval) =0;
dvander@353
   122
dvander@353
   123
		/**
dvander@353
   124
		 * @brief Prints a string to the remote server console. 
dvander@353
   125
		 * 
dvander@353
   126
		 * Note: new lines are not appended.
dvander@353
   127
		 *
dvander@353
   128
		 * @param msg			 	Message string.
dvander@353
   129
		 */
dvander@353
   130
		virtual void ConsolePrint(const char *msg) =0;
dvander@353
   131
dvander@353
   132
		/**
dvander@353
   133
		 * @brief Returns whether remote printing is available.
dvander@353
   134
		 *
dvander@353
   135
		 * @return					True if remote printing is available, 
dvander@353
   136
		 * 							otherwise returns false.
dvander@353
   137
		 */
dvander@353
   138
		virtual bool IsRemotePrintingAvailable() =0;
dvander@353
   139
dvander@353
   140
		/**
dvander@353
   141
		 * @brief Prints text in the specified client's console.
dvander@353
   142
		 *
dvander@353
   143
		 * @param client			Client edict pointer.
dvander@353
   144
		 * @param msg				Message string.
dvander@353
   145
		 */
dvander@353
   146
		virtual void ClientConsolePrint(edict_t *client, const char *msg) =0;
dvander@353
   147
dvander@353
   148
		/**
dvander@353
   149
		 * @brief Returns a server plugin helper for the given interface 
dvander@353
   150
		 * string.
dvander@353
   151
		 *
dvander@353
   152
		 * @param iface				Interface version
dvander@353
   153
		 * @return					IServerPluginCallbacks pointer.
dvander@353
   154
		 */
dvander@353
   155
		virtual IServerPluginCallbacks *GetVSPCallbacks(const char *iface) =0;
dvander@353
   156
dvander@353
   157
		/**
dvander@353
   158
		 * @brief Halts the server with a fatal error message.
dvander@353
   159
		 *
dvander@356
   160
		 * No newline is appended.
dvander@356
   161
		 *
dvander@353
   162
		 * @param fmt				Formatted message string.
dvander@353
   163
		 * @param ...				Format parameters.
dvander@353
   164
		 */
dvander@353
   165
		virtual void DisplayError(const char *fmt, ...) =0;
dvander@353
   166
dvander@353
   167
		/**
dvander@353
   168
		 * @brief Sends the server a warning message.
dvander@353
   169
		 *
dvander@356
   170
		 * No newline is appended.
dvander@356
   171
		 *
dvander@353
   172
		 * @param fmt				Formatted message string.
dvander@353
   173
		 * @param ...				Format parameters.
dvander@353
   174
		 */
dvander@353
   175
		virtual void DisplayWarning(const char *fmt, ...) =0;
dvander@353
   176
dvander@353
   177
		/**
dvander@353
   178
		 * @brief Attempts to notify the provider of the gamedll version being 
dvander@353
   179
		 * used.
dvander@353
   180
		 *
dvander@353
   181
		 * @param iface				Interface string.
dvander@353
   182
		 * @return					Version number on success, 0 otherwise.
dvander@353
   183
		 */
dvander@353
   184
		virtual int TryServerGameDLL(const char *iface) =0;
dvander@353
   185
dvander@353
   186
		/**
dvander@353
   187
		 * @brief Notifies the provider that the DLLInit pre-hook is almost done.
dvander@353
   188
		 */
dvander@359
   189
		virtual void Notify_DLLInit_Pre(void *gamedll,
dvander@359
   190
			CreateInterfaceFn engineFactory, 
dvander@359
   191
			CreateInterfaceFn serverFactory) =0;
dvander@353
   192
dvander@365
   193
		virtual void Notify_DLLShutdown_Pre() =0;
dvander@365
   194
dvander@353
   195
		/**
dvander@353
   196
		 * @brief Wrapper around IVEngineServer::ServerCommand()
dvander@353
   197
		 *
dvander@353
   198
		 * @param cmd				Command string.
dvander@353
   199
		 */
dvander@353
   200
		virtual void ServerCommand(const char *cmd) =0;
dvander@353
   201
dvander@353
   202
		/**
dvander@353
   203
		 * @brief Creates a ConVar pointer.
dvander@353
   204
		 *
dvander@353
   205
		 * @param name				ConVar name.
dvander@353
   206
		 * @param defval			Default value string.
dvander@353
   207
		 * @param flags				ConVar flags.
dvander@353
   208
		 * @param help				Help text.
dvander@353
   209
		 * @return					ConVar pointer.
dvander@353
   210
		 */
dvander@353
   211
		virtual ConVar *CreateConVar(const char *name, 
dvander@353
   212
			const char *defval, 
dvander@353
   213
			const char *help,
dvander@353
   214
			int flags) =0;
dvander@353
   215
dvander@353
   216
		/**
dvander@353
   217
		 * @brief Returns the string value of a ConVar.
dvander@353
   218
		 *
dvander@353
   219
		 * @param convar			ConVar pointer.
dvander@353
   220
		 * @return					String value.
dvander@353
   221
		 */
dvander@353
   222
		virtual const char *GetConVarString(ConVar *convar) =0;
dvander@353
   223
dvander@353
   224
		/**
dvander@353
   225
		 * @brief Retrieves the game description.
dvander@353
   226
		 *
dvander@353
   227
		 * @return					Game description.
dvander@353
   228
		 */
dvander@353
   229
		virtual const char *GetGameDescription() =0;
dvander@353
   230
dvander@353
   231
		/**
dvander@353
   232
		 * @brief Returns the ConCommandBase accessor.
dvander@353
   233
		 *
dvander@353
   234
		 * @return				An IConCommandBaseAccessor pointer.
dvander@353
   235
		 */
dvander@353
   236
		virtual IConCommandBaseAccessor *GetConCommandBaseAccessor() =0;
dvander@353
   237
dvander@353
   238
		/**
dvander@353
   239
		 * @brief Registers a ConCommandBase.
dvander@353
   240
		 *
dvander@353
   241
		 * @param pCommand		ConCommandBase to register.
dvander@353
   242
		 * @return				True if successful, false otherwise.
dvander@353
   243
		 */
dvander@353
   244
		virtual bool RegisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@353
   245
dvander@353
   246
		/**
dvander@353
   247
		 * @brief Unregisters a ConCommandBase.
dvander@353
   248
		 *
dvander@353
   249
		 * @param pCommand		ConCommandBase to unlink.
dvander@353
   250
		 */
dvander@353
   251
		virtual void UnregisterConCommandBase(ConCommandBase *pCommand) =0;
dvander@353
   252
dvander@353
   253
		/**
dvander@353
   254
		 * @brief Returns whether a ConCommandBase is a command or not.
dvander@353
   255
		 *
dvander@353
   256
		 * @param pCommand		ConCommandBase pointer.
dvander@353
   257
		 * @return				True if a command, false otherwise.
dvander@353
   258
		 */
dvander@353
   259
		virtual bool IsConCommandBaseACommand(ConCommandBase *pCommand) =0;
dvander@353
   260
dvander@353
   261
		/**
dvander@353
   262
		 * @brief Returns the number of user messages in the GameDLL.
dvander@353
   263
		 *
dvander@353
   264
		 * @return				Number of user messages, or -1 if SourceMM has 
dvander@353
   265
		 *						failed to get user message list.
dvander@353
   266
		 */
dvander@353
   267
		virtual int GetUserMessageCount() =0;
dvander@353
   268
dvander@353
   269
		/**
dvander@353
   270
		 * @brief Returns the index of the specified user message.
dvander@353
   271
		 *
dvander@353
   272
		 * @param name			User message name.
dvander@353
   273
		 * @param size			Optional pointer to store size of user message.
dvander@353
   274
		 * @return				Message index, or -1 on failure.
dvander@353
   275
		 */
dvander@353
   276
		virtual int FindUserMessage(const char *name, int *size=NULL) =0;
dvander@353
   277
dvander@353
   278
		/**
dvander@353
   279
		 * @brief Returns the name of the specified user message.
dvander@353
   280
		 *
dvander@353
   281
		 * @param index			User message index.
dvander@353
   282
		 * @param size			Optional pointer to store size of user message.
dvander@353
   283
		 * @return				Message name, or NULL on failure.
dvander@353
   284
		 */
dvander@353
   285
		virtual const char *GetUserMessage(int index, int *size=NULL) =0;
dvander@353
   286
	};
dvander@353
   287
};
dvander@353
   288
dvander@359
   289
extern PluginId g_PLID;
dvander@359
   290
extern SourceHook::ISourceHook *g_SHPtr;
dvander@359
   291
extern SourceMM::IMetamodSourceProvider *provider;
dvander@359
   292
dvander@353
   293
#endif //_INCLUDE_METAMOD_SOURCE_SUPPORT_H_
dvander@353
   294