3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is part of the SourceMod/SourcePawn SDK. This file may only be used
8 * or modified under the Terms and Conditions of its License Agreement, which is found
9 * in LICENSE.txt. The Terms and Conditions for making SourceMod extensions/plugins
10 * may change at any time. To view the latest information, see:
11 * http://www.sourcemod.net/license.php
16 #if defined _sdktools_included
19 #define _sdktools_included
22 #include <sdktools_engine>
23 #include <sdktools_functions>
24 #if !defined SDKTOOLS_DISABLE_SOUNDAPI
25 #include <sdktools_sound>
27 #include <sdktools_stringtables>
28 #include <sdktools_trace>
29 #include <sdktools_tempents>
30 #include <sdktools_tempents_stocks>
31 #include <sdktools_voice>
35 SDKCall_Static, /**< Static call */
36 SDKCall_Entity, /**< CBaseEntity call */
37 SDKCall_Player, /**< CBasePlayer call */
38 SDKCall_GameRules, /**< CGameRules call */
43 SDKLibrary_Server, /**< server.dll/server_i486.so */
44 SDKLibrary_Engine, /**< engine.dll/engine_*.so */
47 enum SDKFuncConfSource
49 SDKConf_Virtual = 0, /**< Read a virtual index from the Offsets section */
50 SDKConf_Signature = 1, /**< Read a signature from the Signatures section */
55 SDKType_CBaseEntity, /**< CBaseEntity (always as pointer) */
56 SDKType_CBasePlayer, /**< CBasePlayer (always as pointer) */
57 SDKType_Vector, /**< Vector (pointer, byval, or byref) */
58 SDKType_QAngle, /**< QAngles (pointer, byval, or byref) */
59 SDKType_PlainOldData, /**< Integer/generic data <=32bit (any) */
60 SDKType_Float, /**< Float (any) */
61 SDKType_Edict, /**< edict_t (always as pointer) */
62 SDKType_String, /**< NULL-terminated string (always as pointer) */
63 SDKType_Bool, /**< Boolean (any) */
68 SDKPass_Pointer, /**< Pass as a pointer */
69 SDKPass_Plain, /**< Pass as plain data */
70 SDKPass_ByValue, /**< Pass an object by value */
71 SDKPass_ByRef, /**< Pass an object by reference */
74 #define VDECODE_FLAG_ALLOWNULL (1<<0) /**< Allow NULL for pointers */
75 #define VDECODE_FLAG_ALLOWNOTINGAME (1<<1) /**< Allow players not in game */
76 #define VDECODE_FLAG_ALLOWWORLD (1<<2) /**< Allow World entity */
77 #define VDECODE_FLAG_BYREF (1<<3) /**< Floats/ints by reference */
79 #define VENCODE_FLAG_COPYBACK (1<<0) /**< Copy back data once done */
82 * Starts the preparation of an SDK call.
84 * @param type Type of function call this will be.
87 native StartPrepSDKCall(SDKCallType:type);
90 * Sets the virtual index of the SDK call if it is virtual.
92 * @param vtblidx Virtual table index.
95 native PrepSDKCall_SetVirtual(vtblidx);
98 * Finds an address in a library and sets it as the address to use for the SDK call.
100 * @param lib Library to use.
101 * @param signature Binary data to search for in the library. If it starts with '@',
102 * the bytes parameter is ignored and the signature is interpreted
103 * as a symbol lookup in the library.
104 * @param bytes Number of bytes in the binary search string.
105 * @return True on success, false if nothing was found.
107 native bool:PrepSDKCall_SetSignature(SDKLibrary:lib, const String:signature[], bytes);
110 * Finds an address or virtual function index in a GameConfig file and sets it as
111 * the calling information for the SDK call.
113 * @param gameconf GameConfig Handle, or INVALID_HANDLE to use sdktools.games.txt.
114 * @param source Whether to look in Offsets or Signatures.
115 * @param name Name of the property to find.
116 * @return True on success, false if nothing was found.
118 native bool:PrepSDKCall_SetFromConf(Handle:gameconf, SDKFuncConfSource:source, const String:name[]);
121 * Sets the return information of an SDK call. Do not call this if there is no return data.
122 * This must be called if there is a return value (i.e. it is not necessarily safe to ignore
125 * @param type Data type to convert to/from.
126 * @param pass How the data is passed in C++.
127 * @param decflags Flags on decoding from the plugin to C++.
128 * @param encflags Flags on encoding from C++ to the plugin.
131 native PrepSDKCall_SetReturnInfo(SDKType:type, SDKPassMethod:pass, decflags=0, encflags=0);
134 * Adds a parameter to the calling convention. This should be called in normal ascending order.
136 * @param type Data type to convert to/from.
137 * @param pass How the data is passed in C++.
138 * @param decflags Flags on decoding from the plugin to C++.
139 * @param encflags Flags on encoding from C++ to the plugin.
142 native PrepSDKCall_AddParameter(SDKType:type, SDKPassMethod:pass, decflags=0, encflags=0);
145 * Finalizes an SDK call preparation and returns the resultant Handle.
147 * @return A new SDKCall Handle on success, or INVALID_HANDLE on failure.
149 native Handle:EndPrepSDKCall();
152 * Calls an SDK function with the given parameters.
154 * If the call type is Entity or Player, the index MUST ALWAYS be the FIRST parameter passed.
155 * If the call type is GameRules, then nothing special needs to be passed.
156 * If the return value is a Vector or QAngles, the SECOND parameter must be a Float[3].
157 * If the return value is a string, the THIRD parameter must be a String buffer, and the
158 * FOURTH parameter must be the maximum length.
159 * All parameters must be passed after the above is followed. Failure to follow these
160 * rules will result in crashes or wildly unexpected behavior!
162 * If the return value is a float or integer, the return value will be this value.
163 * If the return value is a CBaseEntity, CBasePlayer, or edict, the return value will
164 * always be the entity index, or -1 for NULL.
166 * @param call SDKCall Handle.
167 * @param ... Call Parameters.
168 * @return Simple return value, if any.
169 * @error Invalid Handle or internal decoding error.
171 native any:SDKCall(Handle:call, any:...);
175 * Do not edit below this line!
177 public Extension:__ext_sdktools =
180 file = "sdktools.ext",
181 #if defined AUTOLOAD_EXTENSIONS
186 #if defined REQUIRE_EXTENSIONS
