dvander@965: /** dvander@965: * vim: set ts=4 : ds@1330: * ============================================================================= dvander@1226: * SourceMod ds@1947: * Copyright (C) 2004-2008 AlliedModders LLC. All rights reserved. ds@1330: * ============================================================================= dvander@965: * ds@1330: * This program is free software; you can redistribute it and/or modify it under ds@1330: * the terms of the GNU General Public License, version 3.0, as published by the ds@1330: * Free Software Foundation. dvander@965: * ds@1330: * This program is distributed in the hope that it will be useful, but WITHOUT ds@1330: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS ds@1330: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more ds@1330: * details. dvander@1226: * ds@1330: * You should have received a copy of the GNU General Public License along with ds@1330: * this program. If not, see . dvander@1226: * ds@1330: * As a special exception, AlliedModders LLC gives you permission to link the ds@1330: * code of this program (as well as its derivative works) to "Half-Life 2," the ds@1330: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software ds@1330: * by the Valve Corporation. You must obey the GNU General Public License in ds@1330: * all respects for all other code used. Additionally, AlliedModders LLC grants ds@1330: * this exception to all derivative works. AlliedModders LLC defines further ds@1330: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007), ds@1330: * or . 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 dvander@965: dvander@965: /** dvander@965: * @file IGameHelpers.h dvander@965: * @brief Provides Source helper functions. dvander@965: */ dvander@965: ds@2051: #define SMINTERFACE_GAMEHELPERS_NAME "IGameHelpers" pred@2596: #define SMINTERFACE_GAMEHELPERS_VERSION 3 ds@2051: ds@2051: class CBaseEntity; pred@2596: class CBaseHandle; ds@2051: class SendProp; ds@2051: class ServerClass; ds@2051: struct edict_t; ds@2051: struct datamap_t; ds@2051: struct typedescription_t; ds@2051: dvander@965: namespace SourceMod dvander@965: { dvander@1847: /** dvander@1847: * @brief Maps the heirarchy of a SendProp. dvander@1847: */ dvander@1847: struct sm_sendprop_info_t dvander@1847: { dvander@1847: SendProp *prop; /**< Property instance. */ dvander@1847: unsigned int actual_offset; /**< Actual computed offset. */ dvander@1847: }; dvander@1847: 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@1847: * @brief Deprecated; use FindSendPropInfo() instead. dvander@965: * dvander@1847: * @param classname Do not use. dvander@1847: * @param offset Do not use. dvander@1847: * @return Do not use. 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@1132: * @return True on success, false on failure. dvander@965: */ dvander@1132: virtual bool TextMsg(int client, int dest, const char *msg) =0; dvander@1423: dvander@1423: /** dvander@1423: * @brief Returns whether the server ls a LAN server. dvander@1423: * dvander@1423: * @return True if LAN server, false otherwise. dvander@1423: */ dvander@1423: virtual bool IsLANServer() =0; dvander@1847: dvander@1847: /** dvander@1847: * @brief Finds a send property in a named ServerClass. dvander@1847: * dvander@1847: * This version, unlike FindInSendTable(), correctly deduces the dvander@1847: * offsets of nested tables. dvander@1847: * dvander@1847: * @param classname ServerClass name (such as CBasePlayer). dvander@1847: * @param offset Offset name (such as m_iAmmo). dvander@1847: * @param info Buffer to store sm_sendprop_info_t data. dvander@1847: * @return True on success, false on failure. dvander@1847: */ dvander@1847: virtual bool FindSendPropInfo(const char *classname, dvander@1847: const char *offset, dvander@1847: sm_sendprop_info_t *info) =0; pred@2596: pred@2596: /** pred@2596: * @brief Converts an entity index into an edict pointer. pred@2596: * pred@2596: * @param index Entity Index. pred@2596: * @return Edict pointer or NULL on failure. pred@2596: */ pred@2596: virtual edict_t *EdictOfIndex(int index) =0; pred@2596: pred@2596: /** pred@2596: * @brief Converts an edict pointer into an entity index. pred@2596: * pred@2596: * @param index Edict Pointer. pred@2596: * @return Entity index or -1 on failure. pred@2596: */ pred@2596: virtual int IndexOfEdict(edict_t *pEnt) =0; pred@2596: pred@2596: /** pred@2596: * @brief Retrieves the edict pointer from a CBaseHandle object. pred@2596: * pred@2596: * @param hndl CBaseHandle object. pred@2596: * @return Edict pointer or NULL on failure. pred@2596: */ pred@2596: virtual edict_t *GetHandleEntity(CBaseHandle &hndl) =0; pred@2596: pred@2596: /** pred@2596: * @brief Sets the edict pointer in a CBaseHandle object. pred@2596: * pred@2596: * @param hndl CBaseHandle object. pred@2596: * @param pEnt Edict pointer. pred@2596: * @noreturn pred@2596: */ pred@2596: virtual void SetHandleEntity(CBaseHandle &hndl, edict_t *pEnt) =0; dvander@965: }; dvander@965: } dvander@965: dvander@966: #endif //_INCLUDE_SOURCEMOD_GAMEHELPERS_H_