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"
kyle@3638: #define SMINTERFACE_GAMEHELPERS_VERSION 9
ds@2051:
ds@2051: class CBaseEntity;
pred@2596: class CBaseHandle;
ds@2051: class SendProp;
ds@2051: class ServerClass;
skamonkey@3460: class ICommandLine;
ds@2051: struct edict_t;
ds@2051: struct datamap_t;
ds@2051: struct typedescription_t;
ds@2051:
skamonkey@3404: #define TEXTMSG_DEST_NOTIFY 1
skamonkey@3404: #define TEXTMSG_DEST_CONSOLE 2
skamonkey@3404: #define TEXTMSG_DEST_CHAT 3
skamonkey@3404: #define TEXTMSG_DEST_CENTER 4
skamonkey@3404:
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.
skamonkey@3404: * @param dest Destination on the HUD (see TEXTMSG_DEST defines above).
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@2628:
dvander@2628: /**
dvander@2628: * @brief Returns the current map name.
dvander@2628: *
dvander@2628: * @return Current map name.
dvander@2628: */
dvander@2628: virtual const char *GetCurrentMap() =0;
dvander@2628:
dvander@2628: /**
dvander@2628: * @brief Wraps IVEngineServer::ServerCommand.
dvander@2628: *
dvander@2628: * @param buffer Command buffer (does not auto \n terminate).
dvander@2628: */
dvander@2628: virtual void ServerCommand(const char *buffer) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Looks up a reference and returns the CBasseEntity* it points to.
pred@2746: *
pred@2746: * @note Supports 'old style' simple indexes and does a serial confirmation check on references.
pred@2746: *
pred@2746: * @param entRef Entity reference.
pred@2746: * @return Entity pointer.
pred@2746: */
pred@2746: virtual CBaseEntity *ReferenceToEntity(cell_t entRef) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Returns the entity reference for an entity.
pred@2746: *
pred@2746: * @param pEntity Entity pointer.
pred@2746: * @return Entity reference.
pred@2746: */
pred@2746: virtual cell_t EntityToReference(CBaseEntity *pEntity) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Returns the entity reference for logical entities, or the index for networked entities.
pred@2746: *
pred@2746: * @param pEntity Entity pointer.
pred@2746: * @return Entity reference/index.
pred@2746: */
pred@2746: virtual cell_t EntityToBCompatRef(CBaseEntity *pEntity) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Converts an entity index into an entity reference.
pred@2746: *
pred@2746: * @param entIndex Entity index.
pred@2746: * @return Entity reference.
pred@2746: */
pred@2746: virtual cell_t IndexToReference(int entIndex) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Retrieves the entity index from a reference.
pred@2746: *
pred@2746: * @param entRef Entity reference.
pred@2746: * @return Entity index.
pred@2746: */
pred@2746: virtual int ReferenceToIndex(cell_t entRef) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Converts a reference into a bcompat version (index for networked entities).
pred@2746: *
pred@2746: * @param entRef Entity reference.
pred@2746: * @return Entity reference/index.
pred@2746: */
pred@2746: virtual cell_t ReferenceToBCompatRef(cell_t entRef) =0;
pred@2746:
pred@2746: /**
pred@2746: * @brief Returns the g_EntList pointer.
pred@2746: *
pred@2746: * @return g_EntList pointer.
pred@2746: */
skamonkey@3301: virtual void *GetGlobalEntityList() =0;
skamonkey@3301:
skamonkey@3301: /**
skamonkey@3301: * @brief Adds a client to the kick queue, where they will be kicked
skamonkey@3301: * next game frame.
skamonkey@3301: *
skamonkey@3301: * The user ID is used to ensure the correct player is kicked.
skamonkey@3301: *
skamonkey@3301: * @param client The index of the client to kick.
skamonkey@3301: * @param userid The user ID of the client to kick.
skamonkey@3301: * @param msg The kick message to show to the player.
skamonkey@3301: */
theY4Kman@2777: virtual void AddDelayedKick(int client, int userid, const char *msg) =0;
skamonkey@3301:
skamonkey@3301: /**
skamonkey@3301: * @brief Returns the uncomputed offset of a SendProp.
skamonkey@3301: *
skamonkey@3301: * @param prop SendProp pointer.
skamonkey@3301: * @return Uncomputed sendprop offset.
skamonkey@3301: */
skamonkey@3300: virtual int GetSendPropOffset(SendProp *prop) =0;
skamonkey@3300:
skamonkey@3300: /**
skamonkey@3300: * @brief Sends a hint message to a client.
skamonkey@3300: *
skamonkey@3300: * @param client Client index.
skamonkey@3300: * @param msg Message to send.
skamonkey@3300: * @return True on success, false on failure.
skamonkey@3300: */
skamonkey@3301: virtual bool HintTextMsg(int client, const char *msg) =0;
skamonkey@3460:
skamonkey@3460: /**
skamonkey@3460: * @brief Retrieves the Valve command line pointer.
skamonkey@3460: *
skamonkey@3460: * @return ICommandLine ptr or NULL if not found.
skamonkey@3460: */
skamonkey@3460: virtual ICommandLine *GetValveCommandLine() =0;
kyle@3638:
kyle@3638: /**
kyle@3638: * @brief Gets a Classname from an edict_t pointer.
kyle@3638: *
kyle@3638: * @param pEdict edict_t pointer.
kyle@3638: * @return Pointer to the string, or NULL if bad pointer.
kyle@3638: */
kyle@3638: virtual const char *GetEntityClassname(edict_t *pEdict) =0;
kyle@3638:
kyle@3638: /**
kyle@3638: * @brief Gets a Classname from an CBaseEntity pointer.
kyle@3638: *
kyle@3638: * @param pEntity CBaseEntity pointer.
kyle@3638: * @return Pointer to the string, or NULL if bad pointer.
kyle@3638: */
kyle@3638: virtual const char *GetEntityClassname(CBaseEntity *pEntity) =0;
skamonkey@3789:
skamonkey@3789: /**
skamonkey@3789: * @brief Returns whether or not a map name is valid to use with the
skamonkey@3789: * engine's Changelevel functionality. It need not be an exact filename on
skamonkey@3789: * some engines. For a check on the exact name, use IVEngineServer::IsMapValid.
skamonkey@3789: *
skamonkey@3789: * @param map Map name.
skamonkey@3789: * @return True if valid, otherwise false.
skamonkey@3789: */
skamonkey@3789: virtual bool IsMapValid(const char *map) =0;
dvander@965: };
dvander@965: }
dvander@965:
dvander@966: #endif //_INCLUDE_SOURCEMOD_GAMEHELPERS_H_