/**

 * vim: set ts=4 :

 * =============================================================================

 * SourceMod

 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.

 * =============================================================================

 *

 * This program is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, version 3.0, as published by the

 * Free Software Foundation.

 * 

 * This program is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more

 * details.

 *

 * You should have received a copy of the GNU General Public License along with

 * this program.  If not, see <http://www.gnu.org/licenses/>.

 *

 * As a special exception, AlliedModders LLC gives you permission to link the

 * code of this program (as well as its derivative works) to "Half-Life 2," the

 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software

 * by the Valve Corporation.  You must obey the GNU General Public License in

 * all respects for all other code used.  Additionally, AlliedModders LLC grants

 * this exception to all derivative works.  AlliedModders LLC defines further

 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),

 * or <http://www.sourcemod.net/license.php>.

 *

 * Version: $Id$

 */

#ifndef _INCLUDE_SOURCEMOD_GAMEHELPERS_H_

#define _INCLUDE_SOURCEMOD_GAMEHELPERS_H_

#include <IShareSys.h>

/**

 * @file IGameHelpers.h

 * @brief Provides Source helper functions.

 */

#define SMINTERFACE_GAMEHELPERS_NAME		"IGameHelpers"

#define SMINTERFACE_GAMEHELPERS_VERSION		2

class CBaseEntity;

class SendProp;

class ServerClass;

struct edict_t;

struct datamap_t;

struct typedescription_t;

namespace SourceMod

{

	/**

	 * @brief Maps the heirarchy of a SendProp.

	 */

	struct sm_sendprop_info_t

	{

		SendProp *prop;					/**< Property instance. */

		unsigned int actual_offset;		/**< Actual computed offset. */

	};

	class IGameHelpers : public SMInterface

	{

	public:

		virtual const char *GetInterfaceName()

		{

			return SMINTERFACE_GAMEHELPERS_NAME;

		}

		virtual unsigned int GetInterfaceVersion()

		{

			return SMINTERFACE_GAMEHELPERS_VERSION;

		}

	public:

		/**

		 * @brief Deprecated; use FindSendPropInfo() instead.

		 *

		 * @param classname		Do not use.

		 * @param offset		Do not use.

		 * @return				Do not use.

		 */

		virtual SendProp *FindInSendTable(const char *classname, const char *offset) =0;

		/**

		 * @brief Finds a named server class.

		 *

		 * @return				ServerClass pointer on success, NULL on failure.

		 */

		virtual ServerClass *FindServerClass(const char *classname) =0;

		/**

		 * @brief Finds a datamap_t definition.

		 *

		 * @param pMap			datamap_t pointer.

		 * @param offset		Property name.

		 * @return				typedescription_t pointer on success, NULL 

		 *						on failure.

		 */

		virtual typedescription_t *FindInDataMap(datamap_t *pMap, const char *offset) =0;

		/**

		 * @brief Retrieves an entity's datamap_t pointer.

		 *

		 * @param pEntity		CBaseEntity entity.

		 * @return				datamap_t pointer, or NULL on failure.

		 */

		virtual datamap_t *GetDataMap(CBaseEntity *pEntity) =0;

		/**

		 * @brief Marks an edict as state changed for an offset.

		 *

		 * @param pEdict		Edict pointer.

		 * @param offset		Offset index.

		 */

		virtual void SetEdictStateChanged(edict_t *pEdict, unsigned short offset) =0;

		/**

		 * @brief Sends a text message to a client.

		 *

		 * @param client		Client index.

		 * @param dest			Destination on the HUD.

		 * @param msg			Message to send.

		 * @return				True on success, false on failure.

		 */

		virtual bool TextMsg(int client, int dest, const char *msg) =0;

		/**

		 * @brief Returns whether the server ls a LAN server.

		 * 

		 * @return				True if LAN server, false otherwise.

		 */

		virtual bool IsLANServer() =0;

		/**

		 * @brief Finds a send property in a named ServerClass.

		 *

		 * This version, unlike FindInSendTable(), correctly deduces the 

		 * offsets of nested tables.

		 *

		 * @param classname		ServerClass name (such as CBasePlayer).

		 * @param offset		Offset name (such as m_iAmmo).

		 * @param info			Buffer to store sm_sendprop_info_t data.

		 * @return				True on success, false on failure.

		 */

		virtual bool FindSendPropInfo(const char *classname,

			const char *offset,

			sm_sendprop_info_t *info) =0;

	};

}

#endif //_INCLUDE_SOURCEMOD_GAMEHELPERS_H_