dvander@965: /**
dvander@965:  * vim: set ts=4 :
dvander@965:  * ===============================================================
dvander@965:  * SourceMod, Copyright (C) 2004-2007 AlliedModders LLC. 
dvander@965:  * All rights reserved.
dvander@965:  * ===============================================================
dvander@965:  *
dvander@965:  *  This file is part of the SourceMod/SourcePawn SDK.  This file may only be 
dvander@965:  * used or modified under the Terms and Conditions of its License Agreement, 
dvander@965:  * which is found in public/licenses/LICENSE.txt.  As of this notice, derivative 
dvander@965:  * works must be licensed under the GNU General Public License (version 2 or 
dvander@965:  * greater).  A copy of the GPL is included under public/licenses/GPL.txt.
dvander@965:  * 
dvander@965:  * To view the latest information, see: http://www.sourcemod.net/license.php
dvander@965:  *
dvander@965:  * Version: $Id$
dvander@965:  */
dvander@965: 
dvander@965: #ifndef _INCLUDE_SOURCEMOD_GAMEHELPERS_H_
dvander@965: #define _INCLUDE_SOURCEMOD_GAMEHELPERS_H_
dvander@965: 
dvander@965: #include <IShareSys.h>
dvander@965: #include <dt_send.h>
dvander@965: #include <server_class.h>
dvander@965: #include <datamap.h>
dvander@965: #include <edict.h>
dvander@965: 
dvander@965: #define SMINTERFACE_GAMEHELPERS_NAME		"IGameHelpers"
dvander@965: #define SMINTERFACE_GAMEHELPERS_VERSION		1
dvander@965: 
dvander@965: /**
dvander@965:  * @file IGameHelpers.h
dvander@965:  * @brief Provides Source helper functions.
dvander@965:  */
dvander@965: 
dvander@965: namespace SourceMod
dvander@965: {
dvander@965: 	class IGameHelpers : public SMInterface
dvander@965: 	{
dvander@965: 	public:
dvander@965: 		virtual const char *GetInterfaceName()
dvander@965: 		{
dvander@965: 			return SMINTERFACE_GAMEHELPERS_NAME;
dvander@965: 		}
dvander@965: 		virtual unsigned int GetInterfaceVersion()
dvander@965: 		{
dvander@965: 			return SMINTERFACE_GAMEHELPERS_VERSION;
dvander@965: 		}
dvander@965: 	public:
dvander@965: 		/**
dvander@965: 		 * @brief Finds a send property in a named send table.
dvander@965: 		 *
dvander@965: 		 * @param classname		Top-level sendtable name.
dvander@965: 		 * @param offset		Property name.
dvander@965: 		 * @return				SendProp pointer on success, NULL on failure.
dvander@965: 		 */
dvander@965: 		virtual SendProp *FindInSendTable(const char *classname, const char *offset) =0;
dvander@965: 
dvander@965: 		/**
dvander@965: 		 * @brief Finds a named server class.
dvander@965: 		 *
dvander@965: 		 * @return				ServerClass pointer on success, NULL on failure.
dvander@965: 		 */
dvander@965: 		virtual ServerClass *FindServerClass(const char *classname) =0;
dvander@965: 
dvander@965: 		/**
dvander@965: 		 * @brief Finds a datamap_t definition.
dvander@965: 		 *
dvander@965: 		 * @param pMap			datamap_t pointer.
dvander@965: 		 * @param offset		Property name.
dvander@965: 		 * @return				typedescription_t pointer on success, NULL 
dvander@965: 		 *						on failure.
dvander@965: 		 */
dvander@965: 		virtual typedescription_t *FindInDataMap(datamap_t *pMap, const char *offset) =0;
dvander@965: 
dvander@965: 		/**
dvander@965: 		 * @brief Retrieves an entity's datamap_t pointer.
dvander@965: 		 *
dvander@965: 		 * @param pEntity		CBaseEntity entity.
dvander@965: 		 * @return				datamap_t pointer, or NULL on failure.
dvander@965: 		 */
dvander@965: 		virtual datamap_t *GetDataMap(CBaseEntity *pEntity) =0;
dvander@965: 
dvander@965: 		/**
dvander@965: 		 * @brief Marks an edict as state changed for an offset.
dvander@965: 		 *
dvander@965: 		 * @param pEdict		Edict pointer.
dvander@965: 		 * @param offset		Offset index.
dvander@965: 		 */
dvander@965: 		virtual void SetEdictStateChanged(edict_t *pEdict, unsigned short offset) =0;
dvander@965: 
dvander@965: 		/**
dvander@965: 		 * @brief Sends a text message to a client.
dvander@965: 		 *
dvander@965: 		 * @param client		Client index.
dvander@965: 		 * @param dest			Destination on the HUD.
dvander@965: 		 * @param msg			Message to send.
dvander@965: 		 */
dvander@965: 		virtual void TextMsg(int client, int dest, const char *msg) =0;
dvander@965: 	};
dvander@965: }
dvander@965: 
dvander@966: #endif //_INCLUDE_SOURCEMOD_GAMEHELPERS_H_