/**
* vim: set ts=4 sw=4 tw=99 noet :
* ======================================================
* Metamod:Source
* Copyright (C) 2004-2009 AlliedModders LLC and authors.
* All rights reserved.
* ======================================================
*
* This software is provided 'as-is', without any express or implied warranty.
* In no event will the authors be held liable for any damages arising from
* the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software in a
* product, an acknowledgment in the product documentation would be
* appreciated but is not required.
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
* 3. This notice may not be removed or altered from any source distribution.
*/
#ifndef _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
#define _INCLUDE_METAMOD_SOURCE_SUPPORT_H_
namespace SourceMM
{
enum
{
ConVarFlag_None = 0,
ConVarFlag_Notify = 1,
ConVarFlag_SpOnly = 2,
};
enum ProvidedHooks
{
#if SOURCE_ENGINE == SE_DOTA
ProvidedHook_StartChangeLevel = 0,
ProvidedHook_Init = 1,
ProvidedHook_StartupServer = 2,
ProvidedHook_SwitchToLoop = 3,
#else
ProvidedHook_LevelInit = 0, /**< IServerGameDLL::LevelInit */
ProvidedHook_LevelShutdown = 1, /**< IServerGameDLL::LevelShutdown */
ProvidedHook_GameInit = 4, /**< IServerGameDLL::GameInit */
#endif
};
/**
* @brief Abstracts command information, since the new engine fixes the
* re-entrancy problems in the tokenization system.
*/
class IMetamodSourceCommandInfo
{
public:
/**
* @brief Returns the argument count such that arguments
* 1 to N are valid arguments, and 0 is the command name.
*
* @return Argument count.
*/
virtual unsigned int GetArgCount() =0;
/**
* @brief Returns the string of an argument number.
*
* @param num Argument number.
* @return Argument text.
*/
virtual const char *GetArg(unsigned int num) =0;
/**
* @brief Returns the entire command argument string.
*
* @return Argument string.
*/
virtual const char *GetArgString() =0;
};
class IMetamodSourceProvider
{
public:
/**
* @brief Returns whether source engine build is compatible.
*
* @param build Source engine build.
* @return True if compatible, false otherwise.
*/
virtual bool IsSourceEngineBuildCompatible(int build) =0;
/**
* @brief Retrieves hook information for each callback. Each hook
* must be implemented.
*
* @param hook Hook information to provide.
* @param pInfo Non-NULL pointer to fill with information
* about the hook's virtual location.
* @return True if supported, false to fail, which
* will cause Metamod:Source to fail.
*/
virtual bool GetHookInfo(ProvidedHooks hook, SourceHook::MemFuncInfo *pInfo) =0;
/**
* @brief Logs a message via IVEngineServer::LogPrint.
*
* @param buffer Buffer to print.
* @return True on success, false if not supported,
* or IVEngineServer is not yet known.
*/
virtual bool LogMessage(const char *buffer) =0;
/**
* @brief Returns the command line value of a parameter. If ICvar
* is not yet loaded, this uses an equivalent function.
*
* @param key Parameter to look up.
* @param val Default string to return if none found.
* @return Parameter value.
*/
virtual const char *GetCommandLineValue(const char *key, const char *defval=NULL) =0;
/**
* @brief Prints a string to the remote server console.
*
* Note: new lines are not appended.
*
* @param msg Message string.
*/
virtual void ConsolePrint(const char *msg) =0;
/**
* @brief Returns whether remote printing is available.
*
* @return True if remote printing is available,
* otherwise returns false.
*/
virtual bool IsRemotePrintingAvailable() =0;
/**
* @brief Prints text in the specified client's console.
*
* @param client Client edict pointer.
* @param msg Message string.
*/
virtual void ClientConsolePrint(edict_t *client, const char *msg) =0;
/**
* @brief Halts the server with a fatal error message.
*
* No newline is appended.
*
* @param fmt Formatted message string.
* @param ... Format parameters.
*/
virtual void DisplayError(const char *fmt, ...) =0;
/**
* @brief Sends the server a warning message.
*
* No newline is appended.
*
* @param fmt Formatted message string.
* @param ... Format parameters.
*/
virtual void DisplayWarning(const char *fmt, ...) =0;
/**
* @brief Attempts to notify the provider of the gamedll version being
* used.
*
* @param iface Interface string.
* @return Version number on success, 0 otherwise.
*/
virtual int TryServerGameDLL(const char *iface) =0;
/**
* @brief Notifies the provider that the DLLInit pre-hook is almost done.
*/
virtual void Notify_DLLInit_Pre(CreateInterfaceFn engineFactory, CreateInterfaceFn serverFactory) =0;
virtual void Notify_DLLShutdown_Pre() =0;
/**
* @brief Wrapper around IVEngineServer::ServerCommand()
*
* @param cmd Command string.
*/
virtual void ServerCommand(const char *cmd) =0;
/**
* @brief Creates a ConVar pointer.
*
* @param name ConVar name.
* @param defval Default value string.
* @param flags ConVar flags.
* @param help Help text.
* @return ConVar pointer.
*/
virtual ConVar *CreateConVar(const char *name,
const char *defval,
const char *help,
int flags) =0;
/**
* @brief Returns the string value of a ConVar.
*
* @param convar ConVar pointer.
* @return String value.
*/
virtual const char *GetConVarString(ConVar *convar) =0;
/**
* @brief Sets a ConVar string.
*
* @param convar ConVar pointer.
* @param str String pointer.
*/
virtual void SetConVarString(ConVar *convar, const char *str) =0;
/**
* @brief Retrieves the absolute path to the game directory.
*
* @param buffer Buffer in which to store path.
* @param maxlen Maximum length of buffer.
*/
virtual void GetGamePath(char *buffer, int maxlen) = 0;
/**
* @brief Retrieves the game description.
*
* @return Game description.
*/
virtual const char *GetGameDescription() =0;
/**
* @brief Returns the ConCommandBase accessor.
*
* @return An IConCommandBaseAccessor pointer.
*/
virtual IConCommandBaseAccessor *GetConCommandBaseAccessor() =0;
/**
* @brief Registers a ConCommandBase.
*
* @param pCommand ConCommandBase to register.
* @return True if successful, false otherwise.
*/
virtual bool RegisterConCommandBase(ConCommandBase *pCommand) =0;
/**
* @brief Unregisters a ConCommandBase.
*
* @param pCommand ConCommandBase to unlink.
*/
virtual void UnregisterConCommandBase(ConCommandBase *pCommand) =0;
/**
* @brief Returns whether a ConCommandBase is a command or not.
*
* @param pCommand ConCommandBase pointer.
* @return True if a command, false otherwise.
*/
virtual bool IsConCommandBaseACommand(ConCommandBase *pCommand) =0;
/**
* @brief Returns the number of user messages in the GameDLL.
*
* @return Number of user messages, or -1 if SourceMM has
* failed to get user message list.
*/
virtual int GetUserMessageCount() =0;
/**
* @brief Returns the index of the specified user message.
*
* @param name User message name.
* @param size Optional pointer to store size of user message.
* @return Message index, or -1 on failure.
*/
virtual int FindUserMessage(const char *name, int *size=NULL) =0;
/**
* @brief Returns the name of the specified user message.
*
* @param index User message index.
* @param size Optional pointer to store size of user message.
* @return Message name, or NULL on failure.
*/
virtual const char *GetUserMessage(int index, int *size=NULL) =0;
/**
* @brief Returns the Source Engine build.
*
* @return SOURCE_ENGINE constant.
*/
virtual int DetermineSourceEngine() =0;
/**
* @brief Processes a VDF plugin file.
*
*/
virtual bool ProcessVDF(const char *file, char path[], size_t path_len, char alias[], size_t alias_len) =0;
/**
* @brief Returns string that describes engine version.
*
* @return Description.
*/
virtual const char *GetEngineDescription() const =0;
};
};
extern PluginId g_PLID;
extern SourceHook::ISourceHook *g_SHPtr;
extern SourceMM::IMetamodSourceProvider *provider;
extern SourceMM::ISmmAPI *g_pMetamod;
#endif //_INCLUDE_METAMOD_SOURCE_SUPPORT_H_