dvander@2168: /**
dvander@2168:  * vim: set ts=4 :
dvander@2168:  * =============================================================================
dvander@2168:  * SourceMod (C)2004-2008 AlliedModders LLC.  All rights reserved.
dvander@2168:  * =============================================================================
dvander@2168:  *
dvander@2168:  * This file is part of the SourceMod/SourcePawn SDK.
dvander@2168:  *
dvander@2168:  * This program is free software; you can redistribute it and/or modify it under
dvander@2168:  * the terms of the GNU General Public License, version 3.0, as published by the
dvander@2168:  * Free Software Foundation.
dvander@2168:  * 
dvander@2168:  * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@2168:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@2168:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
dvander@2168:  * details.
dvander@2168:  *
dvander@2168:  * You should have received a copy of the GNU General Public License along with
dvander@2168:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@2168:  *
dvander@2168:  * As a special exception, AlliedModders LLC gives you permission to link the
dvander@2168:  * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@2168:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@2168:  * by the Valve Corporation.  You must obey the GNU General Public License in
dvander@2168:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
dvander@2168:  * this exception to all derivative works.  AlliedModders LLC defines further
dvander@2168:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@2168:  * or <http://www.sourcemod.net/license.php>.
dvander@2168:  *
dvander@2168:  * Version: $Id$
dvander@2168:  */
dvander@2168: 
dvander@2168: #if defined _sdktools_included
dvander@2168:   #endinput
dvander@2168: #endif
dvander@2168: #define _sdktools_included
dvander@2168: 
dvander@2168: #include <core>
dvander@2168: #include <sdktools_engine>
dvander@2168: #include <sdktools_functions>
dvander@2168: #if !defined SDKTOOLS_DISABLE_SOUNDAPI
dvander@2168: #include <sdktools_sound>
dvander@2168: #endif
dvander@2168: #include <sdktools_stringtables>
dvander@2168: #include <sdktools_trace>
dvander@2168: #include <sdktools_tempents>
dvander@2168: #include <sdktools_tempents_stocks>
dvander@2168: #include <sdktools_voice>
dvander@2168: #include <sdktools_entinput>
dvander@2168: #include <sdktools_entoutput>
dvander@2168: 
dvander@2168: enum SDKCallType
dvander@2168: {
dvander@2168: 	SDKCall_Static,		/**< Static call */
dvander@2168: 	SDKCall_Entity,		/**< CBaseEntity call */
dvander@2168: 	SDKCall_Player,		/**< CBasePlayer call */
dvander@2168: 	SDKCall_GameRules,	/**< CGameRules call */
dvander@2168: 	SDKCall_EntityList,	/**< CGlobalEntityList call */ 
dvander@2168: };
dvander@2168: 
dvander@2168: enum SDKLibrary
dvander@2168: {
dvander@2168: 	SDKLibrary_Server,	/**< server.dll/server_i486.so */
dvander@2168: 	SDKLibrary_Engine,	/**< engine.dll/engine_*.so */
dvander@2168: };
dvander@2168: 
dvander@2168: enum SDKFuncConfSource
dvander@2168: {
dvander@2168: 	SDKConf_Virtual = 0,	/**< Read a virtual index from the Offsets section */
dvander@2168: 	SDKConf_Signature = 1,	/**< Read a signature from the Signatures section */
dvander@2168: };
dvander@2168: 
dvander@2168: enum SDKType
dvander@2168: {
dvander@2168: 	SDKType_CBaseEntity,	/**< CBaseEntity (always as pointer) */
dvander@2168: 	SDKType_CBasePlayer,	/**< CBasePlayer (always as pointer) */
dvander@2168: 	SDKType_Vector,			/**< Vector (pointer, byval, or byref) */
dvander@2168: 	SDKType_QAngle,			/**< QAngles (pointer, byval, or byref) */
dvander@2168: 	SDKType_PlainOldData,	/**< Integer/generic data <=32bit (any) */
dvander@2168: 	SDKType_Float,			/**< Float (any) */
dvander@2168: 	SDKType_Edict,			/**< edict_t (always as pointer) */
dvander@2168: 	SDKType_String,			/**< NULL-terminated string (always as pointer) */
dvander@2168: 	SDKType_Bool,			/**< Boolean (any) */
dvander@2168: };
dvander@2168: 
dvander@2168: enum SDKPassMethod
dvander@2168: {
dvander@2168: 	SDKPass_Pointer,		/**< Pass as a pointer */
dvander@2168: 	SDKPass_Plain,			/**< Pass as plain data */
dvander@2168: 	SDKPass_ByValue,		/**< Pass an object by value */
dvander@2168: 	SDKPass_ByRef,			/**< Pass an object by reference */
dvander@2168: };
dvander@2168: 
dvander@2168: #define VDECODE_FLAG_ALLOWNULL		(1<<0)		/**< Allow NULL for pointers */
dvander@2168: #define VDECODE_FLAG_ALLOWNOTINGAME	(1<<1)		/**< Allow players not in game */
dvander@2168: #define VDECODE_FLAG_ALLOWWORLD		(1<<2)		/**< Allow World entity */
dvander@2168: #define VDECODE_FLAG_BYREF			(1<<3)		/**< Floats/ints by reference */
dvander@2168: 
dvander@2168: #define VENCODE_FLAG_COPYBACK		(1<<0)		/**< Copy back data once done */
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Starts the preparation of an SDK call.
dvander@2168:  *
dvander@2168:  * @param type			Type of function call this will be.
dvander@2168:  * @noreturn
dvander@2168:  */
dvander@2168: native StartPrepSDKCall(SDKCallType:type);
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Sets the virtual index of the SDK call if it is virtual.
dvander@2168:  *
dvander@2168:  * @param vtblidx		Virtual table index.
dvander@2168:  * @noreturn
dvander@2168:  */
dvander@2168: native PrepSDKCall_SetVirtual(vtblidx);
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Finds an address in a library and sets it as the address to use for the SDK call.
dvander@2168:  *
dvander@2168:  * @param lib			Library to use.
dvander@2168:  * @param signature		Binary data to search for in the library.  If it starts with '@',
dvander@2168:  *						the bytes parameter is ignored and the signature is interpreted
dvander@2168:  *						as a symbol lookup in the library.
dvander@2168:  * @param bytes			Number of bytes in the binary search string.
dvander@2168:  * @return				True on success, false if nothing was found.
dvander@2168:  */
dvander@2168: native bool:PrepSDKCall_SetSignature(SDKLibrary:lib, const String:signature[], bytes);
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Finds an address or virtual function index in a GameConfig file and sets it as
dvander@2168:  * the calling information for the SDK call.
dvander@2168:  *
dvander@2168:  * @param gameconf		GameConfig Handle, or INVALID_HANDLE to use sdktools.games.txt.
dvander@2168:  * @param source		Whether to look in Offsets or Signatures.
dvander@2168:  * @param name			Name of the property to find.
dvander@2168:  * @return				True on success, false if nothing was found.
dvander@2168:  */
dvander@2168: native bool:PrepSDKCall_SetFromConf(Handle:gameconf, SDKFuncConfSource:source, const String:name[]);
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Sets the return information of an SDK call.  Do not call this if there is no return data.
dvander@2168:  * This must be called if there is a return value (i.e. it is not necessarily safe to ignore 
dvander@2168:  * the data).
dvander@2168:  *
dvander@2168:  * @param type			Data type to convert to/from.
dvander@2168:  * @param pass			How the data is passed in C++.
dvander@2168:  * @param decflags		Flags on decoding from the plugin to C++.
dvander@2168:  * @param encflags		Flags on encoding from C++ to the plugin.
dvander@2168:  * @noreturn
dvander@2168:  */
dvander@2168: native PrepSDKCall_SetReturnInfo(SDKType:type, SDKPassMethod:pass, decflags=0, encflags=0);
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Adds a parameter to the calling convention.  This should be called in normal ascending order.
dvander@2168:  *
dvander@2168:  * @param type			Data type to convert to/from.
dvander@2168:  * @param pass			How the data is passed in C++.
dvander@2168:  * @param decflags		Flags on decoding from the plugin to C++.
dvander@2168:  * @param encflags		Flags on encoding from C++ to the plugin.
dvander@2168:  * @noreturn
dvander@2168:  */
dvander@2168: native PrepSDKCall_AddParameter(SDKType:type, SDKPassMethod:pass, decflags=0, encflags=0);
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Finalizes an SDK call preparation and returns the resultant Handle.
dvander@2168:  *
dvander@2168:  * @return				A new SDKCall Handle on success, or INVALID_HANDLE on failure.
dvander@2168:  */
dvander@2168: native Handle:EndPrepSDKCall();
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Calls an SDK function with the given parameters.
dvander@2168:  *
dvander@2168:  * If the call type is Entity or Player, the index MUST ALWAYS be the FIRST parameter passed.
dvander@2168:  * If the call type is GameRules, then nothing special needs to be passed.
dvander@2168:  * If the return value is a Vector or QAngles, the SECOND parameter must be a Float[3].
dvander@2168:  * If the return value is a string, the THIRD parameter must be a String buffer, and the
dvander@2168:  *  FOURTH parameter must be the maximum length.
dvander@2168:  * All parameters must be passed after the above is followed.  Failure to follow these 
dvander@2168:  *  rules will result in crashes or wildly unexpected behavior!
dvander@2168:  *
dvander@2168:  * If the return value is a float or integer, the return value will be this value.
dvander@2168:  * If the return value is a CBaseEntity, CBasePlayer, or edict, the return value will
dvander@2168:  *   always be the entity index, or -1 for NULL.
dvander@2168:  *
dvander@2168:  * @param call			SDKCall Handle.
dvander@2168:  * @param ...			Call Parameters.
dvander@2168:  * @return				Simple return value, if any.
dvander@2168:  * @error				Invalid Handle or internal decoding error.
dvander@2168:  */
dvander@2168: native any:SDKCall(Handle:call, any:...);
dvander@2168: 
dvander@2168: #include <sdktools_stocks>
dvander@2168: 
dvander@2168: /**
dvander@2168:  * Do not edit below this line!
dvander@2168:  */
dvander@2168: public Extension:__ext_sdktools = 
dvander@2168: {
dvander@2168: 	name = "SDKTools",
dvander@2168: 	file = "sdktools.ext",
dvander@2168: #if defined AUTOLOAD_EXTENSIONS
dvander@2168: 	autoload = 1,
dvander@2168: #else
dvander@2168: 	autoload = 0,
dvander@2168: #endif
dvander@2168: #if defined REQUIRE_EXTENSIONS
dvander@2168: 	required = 1,
dvander@2168: #else
dvander@2168: 	required = 0,
dvander@2168: #endif
dvander@2168: };