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_functions>
26 SDKCall_Static, /**< Static call */
27 SDKCall_Entity, /**< CBaseEntity call */
28 SDKCall_Player, /**< CBasePlayer call */
33 SDKLibrary_Server, /**< server.dll/server_i486.so */
34 SDKLibrary_Engine, /**< engine.dll/engine_*.so */
37 enum SDKFuncConfSource
39 SDKConf_Virtual = 0, /**< Read a virtual index from the Offsets section */
40 SDKConf_Signature = 1, /**< Read a signature from the Signatures section */
45 SDKType_CBaseEntity, /**< CBaseEntity (always as pointer) */
46 SDKType_CBasePlayer, /**< CBasePlayer (always as pointer) */
47 SDKType_Vector, /**< Vector (pointer, byval, or byref) */
48 SDKType_QAngle, /**< QAngles (pointer, byval, or byref) */
49 SDKType_PlainOldData, /**< Integer/generic data <=32bit (any) */
50 SDKType_Float, /**< Float (any) */
51 SDKType_Edict, /**< edict_t (always as pointer) */
52 SDKType_String, /**< NULL-terminated string (always as pointer) */
53 SDKType_Bool, /**< Boolean (any) */
58 SDKPass_Pointer, /**< Pass as a pointer */
59 SDKPass_Plain, /**< Pass as plain data */
60 SDKPass_ByValue, /**< Pass an object by value */
61 SDKPass_ByRef, /**< Pass an object by reference */
64 #define VDECODE_FLAG_ALLOWNULL (1<<0) /**< Allow NULL for pointers */
65 #define VDECODE_FLAG_ALLOWNOTINGAME (1<<1) /**< Allow players not in game */
66 #define VDECODE_FLAG_ALLOWWORLD (1<<2) /**< Allow World entity */
67 #define VDECODE_FLAG_BYREF (1<<3) /**< Floats/ints by reference */
69 #define VENCODE_FLAG_COPYBACK (1<<0) /**< Copy back data once done */
72 * Starts the preparation of an SDK call.
74 * @param type Type of function call this will be.
77 native StartPrepSDKCall(SDKCallType:type);
80 * Sets the virtual index of the SDK call if it is virtual.
82 * @param vtblidx Virtual table index.
85 native PrepSDKCall_SetVirtual(vtblidx);
88 * Finds an address in a library and sets it as the address to use for the SDK call.
90 * @param lib Library to use.
91 * @param signature Binary data to search for in the library. If it starts with '@',
92 * the bytes parameter is ignored and the signature is interpreted
93 * as a symbol lookup in the library.
94 * @param bytes Number of bytes in the binary search string.
95 * @return True on success, false if nothing was found.
97 native bool:PrepSDKCall_SetSignature(SDKLibrary:lib, const String:signature[], bytes);
100 * Finds an address or virtual function index in a GameConfig file and sets it as
101 * the calling information for the SDK call.
103 * @param gameconf GameConfig Handle, or INVALID_HANDLE to use sdktools.games.txt.
104 * @param source Whether to look in Offsets or Signatures.
105 * @param name Name of the property to find.
106 * @return True on success, false if nothing was found.
108 native bool:PrepSDKCall_SetFromConf(Handle:gameconf, SDKFuncConfSource:source, const String:name[]);
111 * Sets the return information of an SDK call. Do not call this if there is no return data.
112 * This must be called if there is a return value (i.e. it is not necessarily safe to ignore
115 * @param type Data type to convert to/from.
116 * @param pass How the data is passed in C++.
117 * @param decflags Flags on decoding from the plugin to C++.
118 * @param encflags Flags on encoding from C++ to the plugin.
121 native PrepSDKCall_SetReturnInfo(SDKType:type, SDKPassMethod:pass, decflags=0, encflags=0);
124 * Adds a parameter to the calling convention. This should be called in normal ascending order.
126 * @param type Data type to convert to/from.
127 * @param pass How the data is passed in C++.
128 * @param decflags Flags on decoding from the plugin to C++.
129 * @param encflags Flags on encoding from C++ to the plugin.
132 native PrepSDKCall_AddParameter(SDKType:type, SDKPassMethod:pass, decflags=0, encflags=0);
135 * Finalizes an SDK call preparation and returns the resultant Handle.
137 * @return A new SDKCall Handle on success, or INVALID_HANDLE on failure.
139 native Handle:EndPrepSDKCall();
142 * Calls an SDK function with the given parameters.
144 * If the call type is Entity or Player, the index MUST ALWAYS be the FIRST parameter passed.
145 * If the return value is a Vector or QAngles, the SECOND parameter must be a Float[3].
146 * If the return value is a string, the THIRD parameter must be a String buffer, and the
147 * FOURTH parameter must be the maximum length.
148 * All parameters must be passed after the above is followed. Failure to follow these
149 * rules will result in crashes or wildly unexpected behavior!
151 * If the return value is a float or integer, the return value will be this value.
152 * If the return value is a CBaseEntity, CBasePlayer, or edict, the return value will
153 * always be the entity index, or -1 for NULL.
155 * @param call SDKCall Handle.
156 * @param ... Call Parameters.
157 * @return Simple return value, if any.
158 * @error Invalid Handle or internal decoding error.
160 native any:SDKCall(Handle:call, any:...);
164 * Do not edit below this line!
166 public Extension:__ext_sdktools =
169 file = "sdktools.ext",
170 #if defined AUTOLOAD_EXTENSIONS
175 #if defined REQUIRE_EXTENSIONS
