AlliedModders Wiki - User contributions [en]

Natives (SourceMod Development)

2007-08-08T00:09:31Z

Pimpinjuice: /* Strings */

Natives are functions which are available to plugins via Core itself, or a C++ extension. They are called "natives" because they must be translated via a ''native interface''. This article explains the various parameter passing conventions in SourcePawn, as well as how to use them in your own natives.

To understand the contents of this article, you will need to read [[Writing_Extensions#Creating_Native_Functions|Creating Natives]], the Native section in the introductory article on creating extensions.

In this article, <tt>float</tt> refers to the C/C++ data type, and <tt>Float</tt> (note capital 'F') refers to the SourcePawn [[Tags (Scripting)|tag]].

=By Value versus By Reference=
There are two ways to pass integers/Floats to native implementations. They are ''by value'' (ByVal) and ''by reference'' (ByRef). ByVal means that a copy of the value is passed to the native. This is the default behaviour. ByRef means a ''reference'' is passed to the native, and this reference points to the value. Both will be explained below.

Note that arrays and strings, as will be explained later, are always passed by reference. This is because they are usually larger structures, and passing them ByVal would require copying their data, wasting CPU cycles.

==By Value==
Passing by value is the default behaviour for primitive data types (integers, Floats, or any tag that's cell-based). Data is treated normally as raw, copied input. Observe the following native:

<pawn>/**
* Returns the number decremented by one.
*
* @param num Number to decrement.
* @return Decremented number.
*/
native Decrement(num);</pawn>

How would we use this native? Since <tt>num</tt> is passed as a value, it cannot change in the native code. This means we have to use the return value as such:

<pawn>//Decrements a number 5 times
Example(num)
{
num = Decrement(num);
num = Decrement(num);
num = Decrement(num);
num = Decrement(num);
num = Decrement(num);
return num;
}</pawn>

==By Reference==
Let's reuse the above example to use reference passing. Observe the new native below:

<pawn>/**
* Subtracts one from the given number, by reference.
*
* @param num Number to subtract, by reference.
* @noreturn
*/
native Decrement(&num);</pawn>

Note the ampersand ('&') before the parameter name -- this specifies that it is passed by reference. Now, let's see how this would look in our script:

<pawn>Example(num)
{
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
return num;
}</pawn>

In this example, <tt>Decrement</tt> is acting on the <tt>num</tt> variable ''itself'', not a copy of it. Thus, num will decrease 5 times. In fact, scripts can even do this internally. We can shorten the example even more:

<pawn>Example(&num)
{
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
}</pawn>

==When to use By Ref==
There is a misconception that passing by reference is always better then by value. After all, copying data sounds excessive. However, by value in SourcePawn only works on 32bit values, and thus copying the value is inherent to the processor, and trivial.

On the other hand, passing by reference is slightly more expensive. First, the compiler has to generate a little extra code to compute the local address of the variable. Second, the native code itself has to translate the local address to a ''real virtual address'' (native memory).

It is a good idea to only use by reference when you need it. A common usage is when you need to return more than one piece of data, and you can't fit it into the return value of your native or function. In this case, by reference is ideal.

=Integers/Floats=

==By Value==
Natives based purely on by-value floating point or integer input are generally the easiest to make. Let's take a simple function which takes in a Float and an integer, and returns a Float:
<pawn>/**
* Raises a number to an integer power.
*
* @param fNum Base number (Float).
* @param exp Exponent (integer).
* @return Computed exponent result as a Float.
*/
native FloatIntPower(Float:fNum, exp);</pawn>

An implementation of this native might look like:
<cpp>#include <stdlib.h>

static cell_t sm_FloatIntPower(IPluginContext *pContext, const cell_t *params)
{
float f1 = sp_ctof(params[1]);
int num = params[2];

float result = (float)pow(f1, (double)f2);
return sp_ftoc(result);
}</cpp>

Integers, as we saw in the introduction, are accessed from the parameter stack normally. Floats, however, must be ''reinterpret casted'' from a <tt>cell_t</tt> to <tt>float</tt>. Two inline functions are provided for this:
*<tt>sp_ctof</tt>: Convert a <tt>cell_t</tt> to a <tt>float</tt>.
*<tt>sp_ftoc</tt>: Convert a <tt>float</tt> to a <tt>cell_t</tt>.

==By Reference==
By reference is a little more tricky. Let's first implement our <tt>Decrement</tt> native from earlier. A refresher:
<pawn>native Decrement(&num);</pawn>

If we try to use our above code, <tt>params[1]</tt> will no longer hold a value. Instead, it holds a ''local address'' in the plugin. We must use the <tt>LocalToPhysAddr</tt> function to translate this. It takes in a local address and returns back a physical pointer, which we can then modify. This will modify the value in the script.

<cpp>static cell_t sm_Decrement(IPluginContext *pContext, const cell_t *params)
{
cell_t *addr;

/* Translate the address. */
pContext->LocalToPhysAddr(params[1], &addr);

/* Decrement the number */
*addr -= 1;

/* We have to return something, even if the plugin doesn't the value */
return 1;
}</cpp>
''Note: LocalToPhysAddr can return an error code. For all practical purposes, this will never error, unless there is some memory or corruption issue, so checking it isn't necessary.''

This works the same way for floats. Let's say we change our native to this:
<pawn>/**
* Decrements a Float by an integer, and stores the result by reference.
*
* @param fNum Float number to decrement (by ref).
* @param decamt Amount to decrement by.
* @noreturn
*/
native Decrement(&Float:fNum, decamt);
</pawn>

This example is fairly contrived -- our native simply performs a subtract operation. But let's look at the implementation:

<cpp>static cell_t sm_Decrement(IPluginContext *pContext, const cell_t *params)
{
cell_t *addr;

/* Translate the address. */
pContext->LocalToPhysAddr(params[1], &addr);

/* Get the value */
float val = sp_ctof(*addr);
/* Decrement */
val -= params[2];
/* Store back */
*addr = sp_ftoc(val);

/* We have to return something, even if the plugin doesn't the value */
return 1;
}</cpp>

Note that even though the first parameter was passed by reference, the second was not, and is accessed normally.

=Arrays=

==Basic Arrays==
Arrays are always passed by reference. The first example is an array which contains a list of numbers to sum. Observe the native:
<pawn>/**
* Averages an array of numbers.
*
* @param array Array of numbers to average.
* @param num Number of slots in the array.
* @return Average number as a Float.
*/
native Float:Average(array[], num);</pawn>

Usage might look like:
<pawn>Example()
{
new numbers[5] = {5, 6, 1, 3, 8};
return Average(numbers, 5);
}</pawn>

The implementation, like the by ref examples above, requires <tt>LocalToPhysAddr</tt>:
<cpp>static cell_t sm_Average(IPluginContext *pContext, cell_t *params)
{
cell_t *array;
float sum = 0.0f, average;

if (params[2] < 1)
{
/* 0 works without sp_ftoc() */
return 0;
}

pContext->LocalToPhysAddr(params[1], &array);
for (cell_t i=0; i<params[2]; i++)
{
sum += array[i];
}

average = sum / params[2];

return sp_ftoc(average);
}</cpp>

==Float Arrays==
This works similarly for Float arrays. Let's take Vectors an example, with the following native:
<pawn>/**
* Adds two vectors together.
*
* @param r Array to store the result in.
* @param v1 First vector to add.
* @param v2 Second vector to add.
* @noreturn
*/
native AddVectors(Float:r[3], const Float:v1[3], const Float:v2[3]);</pawn>

The implementation is straightforward:
<cpp>static cell_t sm_AddVectors(IPluginContext *pContext, cell_t *params)
{
cell_t *v1, *v2;
float result[3];

pContext->LocalToPhysAddr(params[2], &v1);
pContext->LocalToPhysAddr(params[3], &v2);

result[0] = sp_ctof(v1[0]) + sp_ctof(v2[0]);
result[1] = sp_ctof(v1[1]) + sp_ctof(v2[1]);
result[2] = sp_ctof(v1[2]) + sp_ctof(v2[2]);

cell_t *r;
pContext->LocalToPhysAddr(params[1], &r);
r[0] = sp_ftoc(result[0]);
r[1] = sp_ftoc(result[1]);
r[2] = sp_ftoc(result[2]);

return 1;
}</cpp>

Note that we only store the result after we have computed the input, rather than store directly. This is a bit more work, but is good practice in case users re-use data inputs, and risk overwriting inputs as they are written. For example:

<pawn>new Float:origin[3];
AddVectors(origin, origin, origin);</pawn>

=Strings=
Strings are just like arrays, in that they are passed by reference. The only difference is that each character is stored in a byte, not a 32bit <tt>cell_t</tt>. However, to make coding a bit easier for you, the coder, there are separate functions.
*<tt>LocalToString</tt>: Converts a local address to a physical string address.
*<tt>StringToLocal</tt>: Copies a physical string into a local address buffer.
*<tt>StringToLocalUTF8</tt>: Same as <tt>StringToLocal</tt>, but only copies the maximum amount possible without cutting off any multi byte characters.

First, let's take an easy example: the infamous strlen.
<pawn>/**
* Returns the length of a string.
*
* @param string String to calculate.
* @return Number of bytes in the string.
*/
native strlen(const String:string[]);</pawn>

Implementation:
<cpp>static cell_t sm_StrLen(IPluginContext *pContext, cell_t *params)
{
char *str;
pContext->LocalToString(params[1], &str);
return strlen(str);
}</cpp>

Now, let's say we want to modify the string. There is an important note here: since the string is passed by reference, when you modify the string, it is also modified in the plugin. This is a huge difference from AMX Mod X, where strings were essentially by value in most cases, and you had to copy results back.

Thus, if we wanted to copy a new result into <tt>str</tt> in the above implementation, it would be very easy. If we were implementing <tt>strcpy()</tt>, we would have to use <tt>memmove()</tt> to make sure there are no overlaps. Let's do this:
<pawn>/**
* Copies one string onto another.
*
* @param dest Destination buffer to copy to.
* @param length Maximum length of the buffer.
* @param source Source to copy from.
* @noreturn
*/
native StringCopy(String:dest[], length, const String:source);</pawn>

Implementation using <tt>memmove</tt> for safety:
<cpp>static cell_t sm_StringCopy(IPluginContext *pContext, cell_t *params)
{
char *dest, *src;
size_t len;

pContext->LocalToString(params[1], &dest);
pContext->LocalToString(params[3], &src);

/* Perform bounds checking */
len = strlen(src);
if (len >= params[2])
{
len = params[2] - 1;
} else {
len = params[2];
}

/* Copy */
memmove(dest, src, len);

dest[len] = '\0';

return 1;
}</cpp>

We can also use <tt>StringToLocal</tt>, which would requires a temporary buffer for the original string:
<cpp>static cell_t sm_StringCopy(IPluginContext *pContext, cell_t *params)
{
char *src;
char buffer[2048];
size_t len;

pContext->LocalToString(params[3], &src);

snprintf(buffer, sizeof(buffer), "%s", src);
pContext->StringToLocal(params[1], params[2], buffer);

return 1;
}</cpp>

Generally, you will be using <tt>StringToLocal</tt> for setting strings from outside sources, because it calculates addresses and overflows for you. However, you must make sure that you are not overwriting memory as you are reading it, or else programmers who are using certain types of array slicing may find themselves getting unexpected results.

=Advanced=
==Default Arguments==
Any type of parameter can have a default argument. For example, here is a native where every argument has a default parameter:
<pawn>native RandomStuff(a=0, Float:b=1.0f, &c=0, const String:d[]="", e[3] = {0,1,2});</pawn>

Note that even by reference parameters can have default arguments, as shown above. This does not change the code; it just means the address will contain the default value.

Scripts can force default values. Example:
<pawn>native RandomStuff(a, b, c=0, d=0);

Example()
{
RandomStuff(1, 2, _, d);
}</pawn>

The underscore ('_') means "use the default value for this argument."

==Variable Arguments==
Variable arguments means any number of arguments can be passed. An example of this looks like:
<pawn>native FormatText(const String:format[], {Float,String,_}:...);</pawn>

The <tt>{Float,Handle_}:</tt> is a multi-tag specifier that means any extra parameters must be either a <tt>Float</tt>, <tt>String</tt>, or have no tag at all. The <tt>...</tt> characters mean any number of parameters can follow.

'''There is one important note about variable arguments. They are always passed by reference.''' This means if you have a function which supports variable arguments, and an integer is passed, you will need to use <tt>LocalToPhysAddr</tt> as required with by reference parameters.

==Argument Counts/Backwards Compatibility==
In native handlers, the <tt>params</tt> array has a 0th index which stores the number of parameters it contains. This is useful for both Default Arguments and Variable Arguments.

For example, consider the following native:
<pawn>native DoSomething(index);</pawn>

Let's say that this native exists in plugins for six months. After that, you decide to add a new parameter. You want two conditions to be true after you release this update:
*Old plugins in binary form should still work on newer installations.
*Old plugins should still compile fine on the new API.

The second condition is solved by using default arguments. You should choose a value that will mimic the old functionality of the native.
<pawn>native DoSomething(index, newparam = 0);</pawn>

Next, when changing the implementation, you should detect whether <tt>params[0]</tt> contains ''one parameter'' or ''two parameters''. If it only contains one, you know to use the old version. If it contains two, you know to use the later version and accept the second parameter.

Similarly, you can use the <tt>params[0]</tt> count to detect how many arguments were passed to a variable argument native. This is used primarily in [[Format Class Functions (SourceMod Scripting)|Format Class Functions]] for parameter-count validation.

=Throwing Errors/Invoking the Debugger=
Often, you will write a native and realize that you need to tell the plugin that a serious error has occurred. A good example of this is if you are writing a function which requires a player index, but that index is beyond the reasonable bounds for the maximum players in the server.

In this case, it is a good idea to throw a ''runtime error''. This is an error that halts the plugin and invokes a call trace from the debugger. The halt is not permanent, but it does break the execution flow of the current callback.

There are two ways to throw a native error: <tt>ThrowNativeErrorEx()</tt> or <tt>ThrowNativeError()</tt>. The former lets you specify a detailed error code from <tt>sp_vm_types.h</tt>. The latter is a helper function for generic errors, and it returns 0, allowing you to return with the function itself. For example:

<cpp>static cell_t GetPlayerFrags(IPluginContext *pContext, const cell_t *params)
{
if (params[1] < 0 || params[1] > maxplayers)
{
return pContext->ThrowNativeError("Invalid client index: %d", params[1]);
}
/* ... rest of code ... */
}</cpp>

Don't worry about including extra information, such as your native name or the module name. The debugger knows all of this information and will decide what to print to the user.

[[Category:SourceMod Development]]

Natives (SourceMod Development)

2007-08-07T23:46:26Z

Pimpinjuice: /* Strings */

Natives are functions which are available to plugins via Core itself, or a C++ extension. They are called "natives" because they must be translated via a ''native interface''. This article explains the various parameter passing conventions in SourcePawn, as well as how to use them in your own natives.

To understand the contents of this article, you will need to read [[Writing_Extensions#Creating_Native_Functions|Creating Natives]], the Native section in the introductory article on creating extensions.

In this article, <tt>float</tt> refers to the C/C++ data type, and <tt>Float</tt> (note capital 'F') refers to the SourcePawn [[Tags (Scripting)|tag]].

=By Value versus By Reference=
There are two ways to pass integers/Floats to native implementations. They are ''by value'' (ByVal) and ''by reference'' (ByRef). ByVal means that a copy of the value is passed to the native. This is the default behaviour. ByRef means a ''reference'' is passed to the native, and this reference points to the value. Both will be explained below.

Note that arrays and strings, as will be explained later, are always passed by reference. This is because they are usually larger structures, and passing them ByVal would require copying their data, wasting CPU cycles.

==By Value==
Passing by value is the default behaviour for primitive data types (integers, Floats, or any tag that's cell-based). Data is treated normally as raw, copied input. Observe the following native:

<pawn>/**
* Returns the number decremented by one.
*
* @param num Number to decrement.
* @return Decremented number.
*/
native Decrement(num);</pawn>

How would we use this native? Since <tt>num</tt> is passed as a value, it cannot change in the native code. This means we have to use the return value as such:

<pawn>//Decrements a number 5 times
Example(num)
{
num = Decrement(num);
num = Decrement(num);
num = Decrement(num);
num = Decrement(num);
num = Decrement(num);
return num;
}</pawn>

==By Reference==
Let's reuse the above example to use reference passing. Observe the new native below:

<pawn>/**
* Subtracts one from the given number, by reference.
*
* @param num Number to subtract, by reference.
* @noreturn
*/
native Decrement(&num);</pawn>

Note the ampersand ('&') before the parameter name -- this specifies that it is passed by reference. Now, let's see how this would look in our script:

<pawn>Example(num)
{
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
return num;
}</pawn>

In this example, <tt>Decrement</tt> is acting on the <tt>num</tt> variable ''itself'', not a copy of it. Thus, num will decrease 5 times. In fact, scripts can even do this internally. We can shorten the example even more:

<pawn>Example(&num)
{
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
Decrement(num);
}</pawn>

==When to use By Ref==
There is a misconception that passing by reference is always better then by value. After all, copying data sounds excessive. However, by value in SourcePawn only works on 32bit values, and thus copying the value is inherent to the processor, and trivial.

On the other hand, passing by reference is slightly more expensive. First, the compiler has to generate a little extra code to compute the local address of the variable. Second, the native code itself has to translate the local address to a ''real virtual address'' (native memory).

It is a good idea to only use by reference when you need it. A common usage is when you need to return more than one piece of data, and you can't fit it into the return value of your native or function. In this case, by reference is ideal.

=Integers/Floats=

==By Value==
Natives based purely on by-value floating point or integer input are generally the easiest to make. Let's take a simple function which takes in a Float and an integer, and returns a Float:
<pawn>/**
* Raises a number to an integer power.
*
* @param fNum Base number (Float).
* @param exp Exponent (integer).
* @return Computed exponent result as a Float.
*/
native FloatIntPower(Float:fNum, exp);</pawn>

An implementation of this native might look like:
<cpp>#include <stdlib.h>

static cell_t sm_FloatIntPower(IPluginContext *pContext, const cell_t *params)
{
float f1 = sp_ctof(params[1]);
int num = params[2];

float result = (float)pow(f1, (double)f2);
return sp_ftoc(result);
}</cpp>

Integers, as we saw in the introduction, are accessed from the parameter stack normally. Floats, however, must be ''reinterpret casted'' from a <tt>cell_t</tt> to <tt>float</tt>. Two inline functions are provided for this:
*<tt>sp_ctof</tt>: Convert a <tt>cell_t</tt> to a <tt>float</tt>.
*<tt>sp_ftoc</tt>: Convert a <tt>float</tt> to a <tt>cell_t</tt>.

==By Reference==
By reference is a little more tricky. Let's first implement our <tt>Decrement</tt> native from earlier. A refresher:
<pawn>native Decrement(&num);</pawn>

If we try to use our above code, <tt>params[1]</tt> will no longer hold a value. Instead, it holds a ''local address'' in the plugin. We must use the <tt>LocalToPhysAddr</tt> function to translate this. It takes in a local address and returns back a physical pointer, which we can then modify. This will modify the value in the script.

<cpp>static cell_t sm_Decrement(IPluginContext *pContext, const cell_t *params)
{
cell_t *addr;

/* Translate the address. */
pContext->LocalToPhysAddr(params[1], &addr);

/* Decrement the number */
*addr -= 1;

/* We have to return something, even if the plugin doesn't the value */
return 1;
}</cpp>
''Note: LocalToPhysAddr can return an error code. For all practical purposes, this will never error, unless there is some memory or corruption issue, so checking it isn't necessary.''

This works the same way for floats. Let's say we change our native to this:
<pawn>/**
* Decrements a Float by an integer, and stores the result by reference.
*
* @param fNum Float number to decrement (by ref).
* @param decamt Amount to decrement by.
* @noreturn
*/
native Decrement(&Float:fNum, decamt);
</pawn>

This example is fairly contrived -- our native simply performs a subtract operation. But let's look at the implementation:

<cpp>static cell_t sm_Decrement(IPluginContext *pContext, const cell_t *params)
{
cell_t *addr;

/* Translate the address. */
pContext->LocalToPhysAddr(params[1], &addr);

/* Get the value */
float val = sp_ctof(*addr);
/* Decrement */
val -= params[2];
/* Store back */
*addr = sp_ftoc(val);

/* We have to return something, even if the plugin doesn't the value */
return 1;
}</cpp>

Note that even though the first parameter was passed by reference, the second was not, and is accessed normally.

=Arrays=

==Basic Arrays==
Arrays are always passed by reference. The first example is an array which contains a list of numbers to sum. Observe the native:
<pawn>/**
* Averages an array of numbers.
*
* @param array Array of numbers to average.
* @param num Number of slots in the array.
* @return Average number as a Float.
*/
native Float:Average(array[], num);</pawn>

Usage might look like:
<pawn>Example()
{
new numbers[5] = {5, 6, 1, 3, 8};
return Average(numbers, 5);
}</pawn>

The implementation, like the by ref examples above, requires <tt>LocalToPhysAddr</tt>:
<cpp>static cell_t sm_Average(IPluginContext *pContext, cell_t *params)
{
cell_t *array;
float sum = 0.0f, average;

if (params[2] < 1)
{
/* 0 works without sp_ftoc() */
return 0;
}

pContext->LocalToPhysAddr(params[1], &array);
for (cell_t i=0; i<params[2]; i++)
{
sum += array[i];
}

average = sum / params[2];

return sp_ftoc(average);
}</cpp>

==Float Arrays==
This works similarly for Float arrays. Let's take Vectors an example, with the following native:
<pawn>/**
* Adds two vectors together.
*
* @param r Array to store the result in.
* @param v1 First vector to add.
* @param v2 Second vector to add.
* @noreturn
*/
native AddVectors(Float:r[3], const Float:v1[3], const Float:v2[3]);</pawn>

The implementation is straightforward:
<cpp>static cell_t sm_AddVectors(IPluginContext *pContext, cell_t *params)
{
cell_t *v1, *v2;
float result[3];

pContext->LocalToPhysAddr(params[2], &v1);
pContext->LocalToPhysAddr(params[3], &v2);

result[0] = sp_ctof(v1[0]) + sp_ctof(v2[0]);
result[1] = sp_ctof(v1[1]) + sp_ctof(v2[1]);
result[2] = sp_ctof(v1[2]) + sp_ctof(v2[2]);

cell_t *r;
pContext->LocalToPhysAddr(params[1], &r);
r[0] = sp_ftoc(result[0]);
r[1] = sp_ftoc(result[1]);
r[2] = sp_ftoc(result[2]);

return 1;
}</cpp>

Note that we only store the result after we have computed the input, rather than store directly. This is a bit more work, but is good practice in case users re-use data inputs, and risk overwriting inputs as they are written. For example:

<pawn>new Float:origin[3];
AddVectors(origin, origin, origin);</pawn>

=Strings=
Strings are just like arrays, in that they are passed by reference. The only difference is that each character is stored in a byte, not a 32bit <tt>cell_t</tt>. However, to make coding a bit easier for you, the coder, there are separate functions.
*<tt>LocalToString</tt>: Converts a local address to a physical string address.
*<tt>StringToLocal</tt>: Copies a physical string into a local address buffer.
*<tt>StringToLocalUTF8</tt>: Same as <tt>StringToLocal</tt>, but only copies the maximum amount possible without cutting off any multi byte characters.

First, let's take an easy example: the infamous strlen.
<pawn>/**
* Returns the length of a string.
*
* @param string String to calculate.
* @return Number of bytes in the string.
*/
native strlen(const String:string[]);</pawn>

Implementation:
<cpp>static cell_t sm_StrLen(IPluginContext *pContext, cell_t *params)
{
char *str;
pContext->LocalToString(params[1], &str);
return strlen(str);
}</cpp>

Now, let's say we want to modify the string. There is an important note here: since the string is passed by reference, when you modify the string, it is also modified in the plugin. This is a huge difference from AMX Mod X, where strings were essentially by value in most cases, and you had to copy results back.

Thus, if we wanted to copy a new result into <tt>str</tt> in the above implementation, it would be very easy. If we were implementing <tt>strcpy()</tt>, we would have to use <tt>memmove()</tt> to make sure there are no overlaps. Let's do this:
<pawn>/**
* Copies one string onto another.
*
* @param dest Destination buffer to copy to.
* @param length Maximum length of the buffer.
* @param source Source to copy from.
* @noreturn
*/
native StringCopy(String:dest[], length, const String:source);</pawn>

Implementation using <tt>memmove</tt> for safety:
<cpp>static cell_t sm_StringCopy(IPluginContext *pContext, cell_t *params)
{
char *dest, *src;
size_t len;

pContext->LocalToString(params[1], &dest);
pContext->LocalToString(params[3], &src);

/* Perform bounds checking */
len = strlen(src);
if (len >= params[2])
{
len = params[2] - 1;
} else {
len = params[2];
}

/* Copy */
memmove(dest, src, len);

dest[len] = '\0';

return 1;
}</cpp>

We can also use <tt>StringToLocal</tt>, which would requires a temporary buffer for the original string:
<cpp>static cell_t sm_StringCopy(IPluginContext *pContext, cell_t *params)
{
char *src;
char buffer[2048];
size_t len;

pContext->LocalToString(params[3], &src);

pContext->StringToLocal(params[1], params[2], src);

return 1;
}</cpp>

Generally, you will be using <tt>StringToLocal</tt> for setting strings from outside sources, because it calculates addresses and overflows for you. However, you must make sure that you are not overwriting memory as you are reading it, or else programmers who are using certain types of array slicing may find themselves getting unexpected results.

=Advanced=
==Default Arguments==
Any type of parameter can have a default argument. For example, here is a native where every argument has a default parameter:
<pawn>native RandomStuff(a=0, Float:b=1.0f, &c=0, const String:d[]="", e[3] = {0,1,2});</pawn>

Note that even by reference parameters can have default arguments, as shown above. This does not change the code; it just means the address will contain the default value.

Scripts can force default values. Example:
<pawn>native RandomStuff(a, b, c=0, d=0);

Example()
{
RandomStuff(1, 2, _, d);
}</pawn>

The underscore ('_') means "use the default value for this argument."

==Variable Arguments==
Variable arguments means any number of arguments can be passed. An example of this looks like:
<pawn>native FormatText(const String:format[], {Float,String,_}:...);</pawn>

The <tt>{Float,Handle_}:</tt> is a multi-tag specifier that means any extra parameters must be either a <tt>Float</tt>, <tt>String</tt>, or have no tag at all. The <tt>...</tt> characters mean any number of parameters can follow.

'''There is one important note about variable arguments. They are always passed by reference.''' This means if you have a function which supports variable arguments, and an integer is passed, you will need to use <tt>LocalToPhysAddr</tt> as required with by reference parameters.

==Argument Counts/Backwards Compatibility==
In native handlers, the <tt>params</tt> array has a 0th index which stores the number of parameters it contains. This is useful for both Default Arguments and Variable Arguments.

For example, consider the following native:
<pawn>native DoSomething(index);</pawn>

Let's say that this native exists in plugins for six months. After that, you decide to add a new parameter. You want two conditions to be true after you release this update:
*Old plugins in binary form should still work on newer installations.
*Old plugins should still compile fine on the new API.

The second condition is solved by using default arguments. You should choose a value that will mimic the old functionality of the native.
<pawn>native DoSomething(index, newparam = 0);</pawn>

Next, when changing the implementation, you should detect whether <tt>params[0]</tt> contains ''one parameter'' or ''two parameters''. If it only contains one, you know to use the old version. If it contains two, you know to use the later version and accept the second parameter.

Similarly, you can use the <tt>params[0]</tt> count to detect how many arguments were passed to a variable argument native. This is used primarily in [[Format Class Functions (SourceMod Scripting)|Format Class Functions]] for parameter-count validation.

=Throwing Errors/Invoking the Debugger=
Often, you will write a native and realize that you need to tell the plugin that a serious error has occurred. A good example of this is if you are writing a function which requires a player index, but that index is beyond the reasonable bounds for the maximum players in the server.

In this case, it is a good idea to throw a ''runtime error''. This is an error that halts the plugin and invokes a call trace from the debugger. The halt is not permanent, but it does break the execution flow of the current callback.

There are two ways to throw a native error: <tt>ThrowNativeErrorEx()</tt> or <tt>ThrowNativeError()</tt>. The former lets you specify a detailed error code from <tt>sp_vm_types.h</tt>. The latter is a helper function for generic errors, and it returns 0, allowing you to return with the function itself. For example:

<cpp>static cell_t GetPlayerFrags(IPluginContext *pContext, const cell_t *params)
{
if (params[1] < 0 || params[1] > maxplayers)
{
return pContext->ThrowNativeError("Invalid client index: %d", params[1]);
}
/* ... rest of code ... */
}</cpp>

Don't worry about including extra information, such as your native name or the module name. The debugger knows all of this information and will decide what to print to the user.

[[Category:SourceMod Development]]

War3Source Interface

2007-06-21T22:31:55Z

Pimpinjuice:

[[Category:War3Source_Development]]
=What is it?=
The War3Source interface allows users to customize their War3Source server for more suitable game play!

=Enums=
These are enums used for various things such as immunities in War3Source.

==War3Immunity==
<pawn>// The types of immunities you can get/set from.
enum War3Immunity
{
Immunity_Ultimates = 0, // Immune from ultimates
Immunity_HealthTake = 1, // Immune from health taking
Immunity_Explosion = 2, // Immune from explosion based stuff
Immunity_ShopItems = 3, // Immune from shop items
};</pawn>

=Natives=
Natives are commands that you can call to make a modification plug-in for War3Source.

==War3_CreateRace==
<pawn>/**
* Registers a race with the War3Source plugin
* @param name: The name of the race. (max 64)
* @param short: The shortname used for SQL stuff. (max 16)
* @param switchmessage_instant: The message displayed to the player when they are switched to a new race. (max 192)
* @param switchmessage_dead: The message displayed to the play when they try to switch to the race, but they are alive so they need to wait until they die or the new round. (max 192)
* @param skill1: The name of the first skill. (max 64)
* @param skill1_desc: The description of the first skill. (max 192)
* @param skill2: The name of the second skill. (max 64)
* @param skill2_desc: The description of the second skill. (max 192)
* @param skill3: The name of the third skill. (max 64)
* @param skill3_desc: The description of the third skill. (max 192)
* @param ult: The name of the ultimate. (max 64)
* @param ult_desc: The description of the ultimate. (max 192)
* @return The return value will be the race index or -1 if there was a problem.
*/
native War3_CreateRace(String:name[],String:short[],String:switchmessage_instant[],String:switchmessage_dead[],String:skill1[],String:skill1_desc[],String:skill2[],String:skill2_desc[],String:skill3[],String:skill3_desc[],String:ult[],String:ult_desc[]);</pawn>

==War3_CreateShopItem==
<pawn>/**
* Registers a shop item with the War3Source plugin
* @param name: The name of the item. (max 64)
* @param desc: The description of the item. (max 256)
* @param cost: The cost of the item as a string for vector reasons. (max 4 chars)
* @return The return value will be the item index or -1 if there was a problem.
*/
native War3_CreateShopItem(String:name[],String:desc[],String:cost[]);</pawn>

==War3_CreateHelpCommand==
<pawn>/**
* Registers a help command with the War3Source plugin for war3help
* @param name: The name of the command. (max 64)
* @param desc: The description of the command. (max 256)
* @noreturn
*/
native War3_CreateHelpCommand(String:name[],String:desc[]);</pawn>

==War3_GetWar3Player==
<pawn>/**
* Gets the War3Player ID used for the rest of the War3 interface natives.
* @param client: The client's index you want.
* @return The return value will be the War3Player ID, -1 on failure.
*/
native War3_GetWar3Player(client);</pawn>

==War3_GetLevel==
<pawn>/**
* Gets the current level for the provided race.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param race: The race ID returned from War3_CreateRace
* @return The return value will be the level, if -1 then it failed.
*/
native War3_GetLevel(war3player,race);</pawn>

==War3_GetRace==
<pawn>/**
* Gets the current race for the war3player.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @return The return value will be the race of the player, if -1 then it failed.
*/
native War3_GetRace(war3player);</pawn>

==War3_GetXP==
<pawn>/**
* Gets the XP for the provided race.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param race: The race ID returned from War3_CreateRace
* @return The return value will be the xp, if -1 then it failed.
*/
native War3_GetXP(war3player,race);</pawn>

==War3_SetXP==
<pawn>/**
* Sets the XP for the provided race.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param race: The race ID returned from War3_CreateRace
* @param newxp: The XP you want to set to
* @noreturn
*/
native War3_SetXP(war3player,race,newxp);</pawn>

==War3_GetSkillLevel==
<pawn>/**
* Gets the current level for the skill for the provided race.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param race: The race ID returned from War3_CreateRace
* @param skill: The skill you want to lookup with, (0==skill1,1==skill2,2==skill3,3==ultimate)
* @return The return value will be the skill level, if -1 then it failed.
*/
native War3_GetSkillLevel(war3player,race,skill);</pawn>

==War3_GetOwnsItem==
<pawn>/**
* Gets if the player owns a specific item.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param item: The item ID returned from War3_CreateShopItem
* @return The return value will be 1 if they own it, if 0 they don't, if -1 then it failed.
*/
native War3_GetOwnsItem(war3player,item);</pawn>

==War3_SetOwnsItem==
<pawn>/**
* Sets if the player owns a specific item.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param item: The item ID returned from War3_CreateShopItem
* @param owns: 1 if you want them to own it, 0 if you want them not to own it
* @noreturn
*/
native War3_SetOwnsItem(war3player,item,owns);</pawn>

==War3_GetImmunity==
<pawn>/**
* Gets the state of a certain immunity.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param immunity: The immunity you want to check.
* @return The return value will be 1 if they are immune, if 0 they aren't, if -1 then it failed.
*/
native War3_GetImmunity(war3player,War3Immunity:immunity);</pawn>

==War3_SetImmunity==
<pawn>/**
* Sets if the player owns a specific item.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param immunity: The immunity you want to set.
* @param imm_state: The state of immunity, 1 if they are, 0 if they aren't.
* @noreturn
*/
native War3_SetImmunity(war3player,War3Immunity:immunity,imm_state);</pawn>

==War3_SetMaxSpeed==
<pawn>/**
* Sets the speed for the player that is handled within the War3Source system, good for skills and items that set speed so you don't end up making the player slower.
* Pass 1.0 as gravity when they no longer should use the speed, make sure to do this when they no longer have the skill or item, or whatever.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param speed: The speed you want to pass.
* @noreturn
*/
native War3_SetMaxSpeed(war3player,Float:speed);</pawn>

==War3_SetMinGravity==
<pawn>/**
* Sets the gravity for the player that is handled within the War3Source system, good for skills and items that set gravity so you don't end up making the player jump lower.
* Pass 1.0 as gravity when they no longer should use the gravity, make sure to do this when they no longer have the skill or item, or whatever.
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param gravity: The gravity you want to pass.
* @noreturn
*/
native War3_SetMinGravity(war3player,Float:gravity);</pawn>

==War3_SetOverrideSpeed==
<pawn>/**
* Overrides the speed for War3Source, useful for punishing them or whatever.
* Pass 0.0 as speed when you want the War3Source system to take over again, make sure to do this when they are no longer supposed to follow!
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param speed: The speed you want to pass.
* @noreturn
*/
native War3_SetOverrideSpeed(war3player,Float:speed);</pawn>

==War3_SetOverrideGravity==
<pawn>/**
* Overrides the gravity for War3Source, useful for punishing them or whatever.
* Pass 0.0 as gravity when you want the War3Source system to take over again, make sure to do this when they are no longer supposed to follow!
* @param war3player: The War3Player ID to use. Can be retrieved with War3_GetWar3Player.
* @param gravity: The gravity you want to pass.
* @noreturn
*/
native War3_SetOverrideGravity(war3player,Float:gravity);</pawn>

=Forwards=
Forwards are functions that are called when happening.
Here is an example for the OnWar3PlayerAuthed forward.
<pawn>public OnWar3PlayerAuthed(client,war3player)
{
PrintToServer("Client index %d authenticated with the War3Source system, with War3Player ID %d.",client,war3player);
}</pawn>

==OnRaceSelected==
<pawn>/**
* Gets called when someone changes their race.
* @param client: The client's index.
* @param war3player: The War3Player ID of the client.
* @param oldrace: The player's old race.
* @param newrace: The player's new race.
*/
forward OnRaceSelected(client,war3player,oldrace,newrace);</pawn>

==OnUltimateCommand==
<pawn>/**
* Gets called when the +ultimate or -ultimate command is called, IT ISNT ALWAYS FOR YOUR RACE, YOU NEED TO CHECK!!!
* @param client: The client's index.
* @param war3player: The War3Player ID of the client.
* @param race: The race for which it was called.
* @param pressed: If true, +ultimate, false, -ultimate.
*/
forward OnUltimateCommand(client,war3player,race,bool:pressed);</pawn>

==OnItemPurchase==
<pawn>/**
* Gets called when a player purchases an item.
* @param client: The client's index.
* @param war3player: The War3Player ID of the client.
* @param item: The item that was purchased.
*/
forward OnItemPurchase(client,war3player,item);</pawn>

==OnSkillLevelChanged==
<pawn>/**
* Gets called when a skill level is changed.
* @param client: The client's index.
* @param war3player: The War3Player ID of the client.
* @param race: The race effected.
* @param skill: The skill effected.
* @param oldskilllevel: The old skill level.
* @param newskilllevel: The new skill level.
*/
forward OnSkillLevelChanged(client,war3player,race,skill,oldskilllevel,newskilllevel);</pawn>

War3Source Creating Help Commands

2007-06-21T21:42:13Z

Pimpinjuice:

[[Category:War3Source_Development]]
=What is it?=
When someone accesses the War3Source help menu through "war3help", or a variant of the command, you can put your own custom commands on the menu!

=How to do it=
The native is as followed.
<pawn>native War3_CreateHelpCommand(String:name[],String:desc[]);</pawn>

=Example=
This would add the command "say hello there" with the description "This is a test command!" to the menu.
<pawn>public OnPluginStart()
{
War3_CreateHelpCommand("say hello there","This is a test command!");
}</pawn>

War3Source Interface

2007-06-20T13:54:21Z

Pimpinjuice: New page: Category:War3Source_Development Placeholder.

[[Category:War3Source_Development]]
Placeholder.

War3Source Creating Help Commands

2007-06-20T13:53:59Z

Pimpinjuice: New page: Category:War3Source_Development Placeholder.

[[Category:War3Source_Development]]
Placeholder.

War3Source Creating Shop Items

2007-06-20T13:53:36Z

Pimpinjuice: New page: Category:War3Source_Development Placeholder.

[[Category:War3Source_Development]]
Placeholder.

War3Source Creating Races

2007-06-20T13:51:26Z

Pimpinjuice:

[[Category:War3Source_Development]]
Placeholder.

War3Source Creating Races

2007-06-20T13:50:49Z

Pimpinjuice: New page: Placeholder.

Placeholder.

Category:War3Source Development

2007-06-09T19:05:02Z

Pimpinjuice: New page: Category:War3Source Here are the documents on developing for War3Source.

[[Category:War3Source]]
Here are the documents on developing for War3Source.

Category:War3Source

2007-06-09T19:02:18Z

Pimpinjuice: New page: Here are the wiki documents for War3Source.

Here are the wiki documents for War3Source.

War3Source Installation

2007-06-09T19:01:42Z

Pimpinjuice: New page: Category:War3Source Placeholder.

[[Category:War3Source]]
Placeholder.

Useful Signatures (Source)

2007-06-05T01:02:16Z

Pimpinjuice:

=Introduction=
I have posted this page here so I can share some useful [http://wiki.alliedmods.net/Signature_Scanning sigscan] signatures. With these, and the use of [http://forums.alliedmods.net/showthread.php?t=53893 PimpinJuice's SigOffset Extension] you can call some very useful functions from within [[SourceMod]] plugins.

=The difference between SignatureScanCall and SignatureScanCall_NoIndex=
In order to truely understand the difference between the two calls, you need to know how the function you have is constructed.
Lets take two functions, CBaseEntity::Teleport and CGib::SpawnRandomGibs.
In the C++ code of the source engine, the teleport function is constructed as follows:
<pawn>void CBaseEntity::Teleport(Vector newPosition,QAngle newAngle,Vector newVelocity);</pawn>
If you look around in the source code of the source engine, you will find it called like this:
<pawn>pEntity->Teleport(location,angle,velocity);</pawn>
In the case that it is called by a pointer (pEntity->) then you use SignatureScanCall.
Now lets take the spawn random gibs construction:
<pawn>void CGib::SpawnRandomGibs(CBaseEntity *pVictim,int cGibs,GibType_e eGibType);</pawn>
If you look around, it is called like this:
<pawn>CGib::SpawnRandomGibs(pVictimEntity,6,0);</pawn>
In the case the there is NOT a pointer, you would use SignatureScanCall_NoIndex.
If you still do not understand, look below for the examples.

=Function Signatures=
This is the list of all of the functions that we have signatures for.

==CBaseEntity::Spawn==
This function is used to spawn player entities into the game. Either after creation, or re-spawn the player back to their spawn point. This function is good to call once you have changed the value of 'm_iTeamNum'. Once you have changed this value, you will need to call this function so the swapped player has the right skin and game rules associated.

'''The Signature'''
<pawn>\x83\xec\x2c\x53\x55\x56\x57\x68\x2c\x2d\x49\x22\x8b\xf1\xe8\x2d\x1c\xed\xff\x8b\x06\x8b\xce\xff\x90\x28\x04\x00\x00\x80\xbe\xad\x02\x00\x00\x01\x8d\x8e\xad\x02\x00\x00\xc6\x44\x24\x10\x01\x74\x0a\x8d\x54\x24\x10\x52\xe8\x85\xa8\xed\xff\x80\xbe\xae\x02\x00\x00\x01\x8d\x8e\xae\x02\x00\x00\xc6\x44\x24\x10\x01\x74\x0a\x8d\x44\x24\x10\x50\xe8\xb7\xa8\xed\xff\x8b\x16\x8b\xce\xff\x92\x9c\x05\x00\x00\x8b\x8e\xf8\x0b\x00\x00\x8b\xd8</pawn>

'''The Mask'''
<pawn>xxxxxxx?????xx?????xxxxxxxxxxxxxxxxxxxxxxxxxxxx??xxxxx?????xxxxxxxxxxxxxxxxxx??xxxxx?????xxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
107

'''Linux Function'''
<pawn>_ZN11CBaseEntity5SpawnEv</pawn>

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY);</pawn>

==CBaseEntity::Teleport==
This function will teleport an entity to a certain place in the world with a given vector. Useful for moving things across the world, or 'pushing' with a given force

'''The Signature'''
<pawn>\x83\xEC\x18\x53\x56\x8B\xD9\x8B\x0D\x78\xB2\x46\x22\x33\xF6\x33\xC0\x3B\xCE\x7E\x21\x8B\x15\x6C\xB2\x46\x22\xEB\x03\x8D\x49\x00\x39\x1C\x82\x74\x09\x83\xC0\x01\x3B\xC1\x7C\xF4\xEB\x08\x3B\xC6\x0F\x8D\x17\x01\x00\x00\x55\x57\x8D\x44\x24\x10\x50\x51\xB9\x6C\xB2\x46\x22\x89\x5C\x24\x18\xE8\xB4\x88\xF9\xFF\x8D\x4C\x24\x14\x51\x53\x89\x44\x24\x18\x89\x74\x24\x1C\x89\x74\x24\x20\x89\x74\x24\x24\x89\x74\x24\x28\x89\x74\x24\x2C</pawn>

'''The Mask'''
<pawn>xxxxxxx??????xxxxxx?????????????xxx?????xx????xx??????x?????xx?????xxxx?????????xxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
106

'''Linux Function'''
<pawn>_ZN11CBaseEntity8TeleportEPK6VectorPK6QAngleS</pawn>

'''Function Paramaters'''
*'''Vector newPosition'''
**The place to teleport to
*'''QAngle newAngles'''
**The new angle of the entity
*'''Vector newVelocity'''
**Directional vector for velocity

'''Example Call'''
<pawn>new Float:Pos[3];
new Float:Vel[3];
SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_VECTOR, Pos, PARAM_QANGLE, -1, PARAM_VECTOR, Vel);</pawn>

==CBaseEntity::SetModel==
This function will set the model of the entity to the model that you specify. (Yes even player models ;))

'''The Signature'''
<pawn>\x56\x8b\x74\x24\x08\x57\x8b\xf9\x8b\x0d\x8c\x69\x5f\x22\x8b\x01\x56\xff\x50\x08\x8b\x0d\x8c\x69\x5f\x22\x8b\x11\x50\xff\x52\x04\x85\xc0\x74\x20\x8b\x0d\x8c\x69\x5f\x22\x8b\x11\x50\xff\xf2\x24\x83\xf8\x01</pawn>

'''The Mask'''
<pawn>xxxxxxxx??????xxx?????????xxx???xx????????xxx??xxxx</pawn>

'''Length'''
51

'''Linux Function'''
<pawn>_ZN11CBaseEntity8SetModelEPKc</pawn>

'''Function Paramaters'''
*'''const char *szModelName'''
**The model to set to

'''Example Call'''
<pawn>PrecacheModel("models/Alyx.mdl");
SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_CONST_CHAR_PTR, "models/Alyx.mdl");</pawn>

==CBaseEntity::SetModelIndex==
This function will set the model of the entity to the model index that you specify. To see a list of models currently cached and their id's type this into server console
<pawn>sv_cheats 1;listmodels;sv_cheats 0</pawn>

'''The Signature'''
<pawn>\x53\x8b\x5c\x24\x08\x56\x57\x8b\xf9\x66\x8b\x4f\x1e\x8d\x77\x1e\x8d\x44\x24\x10\x66\x3b\x08\x74\x0c\x56\x8d\x4e\xe2\xe8\x4a\xe9\xfd\xff\x66\x89\x18\x8b\xcf</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxx????????????????????</pawn>

'''Length'''
39

'''Linux Function'''
<pawn>_ZN11CBaseEntity13SetModelIndexEi</pawn>

'''Function Paramaters'''
*'''int index '''
**The model index to set to

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_INT, 123);</pawn>

==CBasePlayer::DamageEffect==
This function shows an effect like you would get if you got damaged. Some options dont do anything, but others look kinda cool

'''The Signature'''
<pawn>\x8b\x44\x24\x08\x83\xec\x14\xa8\x01\x56\x57\xeb\xf1\x74\x36\x6a\x01\xb0\x80\x68\xcd\xcc\xcc\x3d\x88\x44\x24\x2c\x88\x44\x24\x2f\x68\x00\x00\x80\x3f\x8d\x44\x24\x30\x50\x56\xc6\x44\x24\x39\x00\xc6\x44\x24\x3a\x00\xe8\x46\x6d\x09\x00\x83\xc4\x14\x5f</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxx????xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx????xxxxx</pawn>

'''Length'''
62

'''Linux Function'''
<pawn>_ZN11CBasePlayer12DamageEffectEfi</pawn>

'''Function Paramaters'''
*'''Float flDamage'''
**[not used]
*'''int fDamageType'''
**DMG_CRUSH (1<<0)
**DMG_DROWN (1<<14)
**DMG_SLASH (1<<2)
**DMG_PLASMA (1<<24)
**DMG_SONIC (1<<9)
**MG_BULLET (1<<1)

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_FLOAT, 0, PARAM_INT, (1<<24));</pawn>

==CBasePlayer::SetFOV==
This function will change the players Field of View (FOV) with a given zoom rate

'''The Signature'''
<pawn>\x53\x57\x8b\x7c\x24\x03\x85\xff\x8b\xd9\x75\x07\x5f\x32\xc0\x5b\xc2\x0c\x00\x8b\x83\x08\x0a\x00\x00\x83\xf8\xff\x56\x8d\xb3\x08\x0a\x00\x00</pawn>

'''The Mask'''
<pawn>xxxxx????????xxxxxxxxx??????xxxxxxx</pawn>

'''Length'''
35

'''Linux Function'''
<pawn>_ZN11CBasePlayer13SetDefaultFOVEi</pawn>

'''Function Paramaters'''
*'''CBaseEntity pRequester'''
**The entity of the player to change FOV of
*'''int FOV'''
**The FOV value (0-360) anything over 180 goes foobar (default 90)
*'''Float zoomRate'''
**Time it takes for the new FOV to zoom in/out

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_CBASEENTITY, client, PARAM_INT, 95, PARAM_FLOAT, 2.0);</pawn>

==CCSPlayer::RoundRespawn==
This function causes a dead player in CS:S to respawn at a spawn point, we all love this one.

'''The Signature'''
<pawn>\x56\x8B\xF1\x8B\x06\xFF\x90\xB8\x04\x00\x00\x8B\x86\xE8\x0D\x00\x00\x85\xC0\x74\x0E\x8B\x50\x18\x85\xD2\x74\x07\x8B\x48\x1C\x03\xCE\xFF\xD2</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxx??xxxxx??xxxxxxx</pawn>

'''Length'''
35

'''Linux Function'''
<pawn>_ZN9CCSPlayer12RoundRespawnEv</pawn>

'''Example Call'''
<pawn>SignatureScanCall(sigSpawn,client,SIGTYPE_CCSPLAYER);</pawn>

==CCSPlayer::SwitchTeam (CS:S ONLY)==
This function will switch team of the player entity. It wont re-spawn the player, but it will switch the player to the new team without them dyeing.

'''The Signature'''
<pawn>\x83\xEC\x10\x56\x57\x8B\x7C\x24\x1C\x57\x8B\xF1\xE8\x7F\xE8\xF9\xFF\x83\xC4\x04\x85\xC0\x0F\x84\xEA\x00\x00\x00\x83\xFF\x03\x74\x09\x83\xFF\x02\x0F\x85\xDC\x00\x00\x00\x8B\xCE\xE8\xAF\x22\xE1\xFF\x3B\xF8\x0F\x84\xDC\x00\x00\x00\x57\x8B\xCE\xC6\x86\x14\x0E</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxx????xxxxxxxxxxxxxxxxxxxxxxxxxxxx????xxxxxxxxxxxxx??</pawn>

'''Length'''
64

'''Linux Function'''
<pawn>_ZN9CCSPlayer10SwitchTeamEi</pawn>

'''Function Paramaters'''
*'''int iTeamIndex'''
**The new team index of the player

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_INT, 2);</pawn>

==CBaseAnimating::Ignite==
This function will ignite the entity (duh)

'''The Signature'''
<pawn>\x56\x8B\xF1\x8B\x86\xBC\x00\x00\x00\xC1\xE8\x1B\xA8\x01\x0F\x85\x9A\x00\x00\x00\x8B\x16\xFF\x92\xF0\x00\x00\x00\x80\x7C\x24\x0C\x00\x74\x08\x84\xC0\x0F\x84\x83\x00\x00\x00\x3C\x01\x75\x20\x80\x7C\x24\x14\x00\x75\x19\x8B\xCE\xE8\x83\x1A\x01\x00\x85\xC0\x74\x0E\x8B\x10\x8B\xC8\xFF\x92\x08\x05\x00\x00\x84\xC0\x74\x5F\x57\x6A\x01\x56\xE8\x48\xEA\x07\x00\x8B\xF8\x83\xC4\x08\x85\xFF\x74\x3D\x8B\x44\x24\x0C\x50\x8B\xCF\xE8\x83\xE5\x07\x00\x68\x00\x00\x00\x08\x8B\xCE</pawn>

'''The Mask'''
<pawn>xxx?????????????????xxx????????????xx??????xx??xxxxx??xxx????????xxxxx?????xx??xxxxx????xxxxxxx??xxxxxxxx????xxxxxxx</pawn>

'''Length'''
116

'''Linux Function'''
<pawn>_ZN14CBaseAnimating6IgniteEfbfb</pawn>

'''Function Paramaters'''
*'''Float flFlameLifetime'''
**The time the fire should burn
*'''bool bNPCOnly'''
**I assume only NPC's get burnt
*'''float flSize'''
**Size of the flames
*'''bool bCalledByLevelDesigner'''
**Dont know what this is; I suggest setting to 0 because you are not the level designer :P

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEANIMATING, PARAM_FLOAT, 25.0, PARAM_INT, 0, PARAM_FLOAT, 100.0, PARAM_INT, 0);</pawn>

==CGib::SpawnRandomGibs==
This function will spawn head gibs from the entity. Even though the signature says 'RandomGibs' the code is only setup to spawn head gibs. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x51\x8b\x44\x24\x0c\x85\xc0\x0f\x8e\x30\x01\x00\x00\x53\x55\x56\x57\x89\x44\x24\x1c\xbb\x01\x00\x00\x00\xed\x9b\x00\x00\x00\x00\x6a\x00\x68\xd8\xeb\x58\x22\x68\x20\x73\x57\x22\x6a\x00\x6a\xff\x68\xdc\x57\x4c\x22\xe8\x46\x55\x01\x00\x83\xc4\x08</pawn>

'''The Mask'''
<pawn>xxxxxxx??????xxxxxxxxxxxx???????????????????xxxx??????????xxx</pawn>

'''Length'''
61

'''Linux Function'''
<pawn>_ZN4CGib15SpawnRandomGibsEP11CBaseEntityi9Gib</pawn>

'''Function Paramaters'''
*'''CBaseEntity pVictim'''
**The entity to spawn gibs from
*'''int cGibs'''
**The amount of gibs to spawn, I suggest anything over 1000000 ^^
*'''GibType_e eGibType'''
**GIB_HUMAN = 0 (Head gib)
**GIB_ALIEN = 1 (Head gib with some blood splatter) MUST PRECACHE "models/gibs/agibs.mdl"

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client, PARAM_INT, 10, PARAM_INT, 1);</pawn>

==UTIL_BloodDrips==
This function will spawn a small 'splash' of blood under the entity. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x57\x8b\x7c\x24\x10\x83\xff\xff\x0f\x84\xe5\x00\x00\x00\x81\xff\xf7\x00\x00\x00\x75\x0b\xa1\x18\xa6\x61\x22\x83\x78\x2c\x00\xeb\x0a\x8b\x0d\xa8\xa6\x61\x22\x83\x79\x2c\x00\x0f\x95\xc0</pawn>

'''The Mask'''
<pawn>xxxxxxxx??????xxxxxx???????xxxx????????xxxxxxx</pawn>

'''Length'''
46

'''Linux Function'''
<pawn>_Z15UTIL_BloodDripsRK6VectorS1_ii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The location to spawn the effect
*'''Vector direction'''
**Dont know what this is, i set it same as origin
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)

'''Example Call'''
<pawn>
new Float:origin[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, origin, PARAM_INT, 247);</pawn>

==UTIL_BloodStream==
Creates a moving stream of blood (like someone threw a bucket of water). Only shows pink/black (missing texture) still fun though. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x8b\x44\x24\x0c\x83\xec\x20\x50\xe8\x53\x5c\x00\x00\x83\xc4\x04\x84\xc0\x74\x61\x56\x8d\x4c\x24\x04\xe8\x42\x0b\xfa\xff\x8b\x74\x24\x28\x56\x8d\x4c\x24\x08\xc7\x44\x24\x08\x7c\x99\x4b\x22\xe8\x4c\x12\xfa\xff\x8b\x44\x24\x34\x3d\xff\x00\x00\x00</pawn>

'''The Mask'''
<pawn>xxxxxxxx?????xxxxx??xxxxx?????xxxxxxxxx?????????????xxxxxxxxx</pawn>

'''Length'''
61

'''Linux Function'''
<pawn>_Z16UTIL_BloodStreamRK6VectorS1_ii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The place the blood starts
*'''Vector direction'''
**The place the blood lands (close to)
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)
*'''int amount'''
**Dunno what this is (alpha?) set to 255

'''Example Call'''
<pawn>
new Float:origin[3];
new Float:direction[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, direction, PARAM_INT, 247, PARAM_INT, 255);</pawn>

==UTIL_BloodSpray==
Makes a blood spray (duh!)'''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x8b\x4c\x24\x0c\x83\xec\x60\x83\xf9\xff\x0f\x84\xa7\x00\x00\x00\x33\xc0\xdb\x44\x24\x70\x89\x44\x24\x34\x89\x44\x24\x44\x66\x89\x44\x24\x48\xd9\x5c\x24\x38\x89\x44\x24\x3c\x89\x44\x24\x40\x89\x44\x24\x4c</pawn>

'''The Mask'''
<pawn>xxxxxxxxxx??????xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
51

'''Linux Function'''
<pawn>_Z15UTIL_BloodSprayRK6VectorS1_iii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The place the blood starts
*'''Vector direction'''
**The place the blood lands (close to)
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)
*'''int amount'''
**Dunno what this is (alpha?) set to 255
*'''int flags'''
**0 nothing
**1 makes a baseball bat like blood spray
**2 makes a ring of blood mist
**3 makes an upward spray
**4 makes clouds of blood mist
**5 seems to be a mixture of the above
**6 seems to be a thicker cloud of dust
**(i cant be bothered to check any more. go experament)
'''Example Call'''
<pawn>
new Float:origin[3];
new Float:direction[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, direction, PARAM_INT, 247, PARAM_INT, 255, PARAM_INT, 5);</pawn>

==UTIL_Tracer (NOT CS:S)==
Uhh.. dont know i assume its for tracer stuff ^^ i guess someone will have a use for it :P '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x83\xec\x60\x8b\x44\x24\x64\x8b\x10\x89\x54\x24\x0c\x8b\x50\x04\x8b\x40\x08\x89\x44\x24\x14\x8b\x44\x24\x68\x89\x54\x24\x10\x8b\x10\x33\xc9\x38\x4c\x24\x78\x89\x14\x24\x8b\x50\x04\x8b\x40\x08\x89\x44\x24\x08\x8b\x44\x24\x97\x89</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
54

'''Linux Function'''
<pawn>_Z11UTIL_TracerRK6VectorS1_iifbPKc</pawn>

'''Function Paramaters'''
*'''Vector vecStart'''
**Starting Vector (duh)
*'''Vector vecEnd'''
**Ending Vector
*'''int EntIndex'''
**Entity index using the tracer
*'''int iAttachment'''
**Dont know (-1 for no attachement)
*'''float flVelocity'''
**Velocity the tracer moves at (m/s?)
*'''bool bWhiz'''
**I assume it emmits a sound?
*'''char ptr pCustomTracerName'''
**A nice name for your tracer
'''Example Call'''
<pawn>
new Float:start[3];
new Float:end[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, start, PARAM_VECTOR, end, PARAM_INT, client, PARAM_INT, -1, PARAM_FLOAT, 10.0, PARAM_INT, 1, PARAM_CONST_CHAR_PTR, "OLLY");</pawn>

==SetMinMaxSize==
Sets the size of the collision box around a Physics entity '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x53\x8b\x5c\x24\x0c\x55\x8b\x6c\x24\x14\x56\x57\x8b\xf5\x2b\xdd\xbf\x03\x00\x00\x00\xd9\x04\x33\xd8\x1e\xdf\xe0\xf6\xc4\x41\x75\x23\x8b\x4c\x24\x14\x85\xc9</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx??xxxxxx</pawn>

'''Length'''
39

'''Linux Function'''
<pawn> [cant find someone help me out?] </pawn>

'''Function Paramaters'''
*'''CBaseEntity pEnt'''
**The entity ptr of the entity you are working with
*'''Vector mins'''
**The minimum size the box will 'squash' to when you run into it
*'''Vector max'''
**The maximum size

'''Example Call'''
<pawn>
new Float:min[3];
new Float:max[3];
SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client, PARAM_VECTOR, min, PARAM_VECTOR, max);</pawn>

==CreateEntityByName==
Creates a new entity from the classname specified (Does NOT spawn the entity) '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x56\x8b\x74\x24\x0c\x83\xfe\xff\x57\x8b\x7c\x24\x0c\x74\x25\x8b\x0d\x68\x69\x5f\x22\x8b\x01\x56\xff\x50\x54\x85\xc0\xa3\x9c\xfa\x5c\x22\x75\x10\x56\x57\x68\x08\x6d\x4e\x22\xff\x15\xfc\xb1\x48\x22\x83\xc4\x0c</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxx??xxxxxxxxx???xx???????xx???????????xxx</pawn>

'''Length'''
52

'''Linux Function'''
<pawn>_Z18CreateEntityByNamePKci</pawn>

'''Function Paramaters'''
*'''char ptr classname'''
**The classname of the entity to make
*'''int iForceEdictIndex'''
**Manually set the edict ID (dont set for auto) (MUST BE > 64)

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CONST_CHAR_PTR, "hostage_entity");</pawn>

'''Result'''
[[Image:De_dust0012.jpg]]

==DispatchSpawn==
Used to spawn created entities, or to respawn players '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x53\x55\x56\x8b\x74\x24\x10\x85\xf6\x57\x0f\x84\x3a\x01\x00\x00\x8b\x1d\xa4\x69\x5f\x22\x8b\x03\x8b\xcb\xff\x50\x60\x8b\x16\x8b\xce\xff\x52\x08\x8b\x0d\xa4\x69\x5f\x22\x8b\x28</pawn>

'''The Mask'''
<pawn>xxxxxxxxxx????????????xxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
44

'''Linux Function'''
<pawn>_Z13DispatchSpawnP11CBaseEntity</pawn>

'''Function Paramaters'''
*'''CBaseEntity pEntity'''
**The entity to spawn

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client);</pawn>

=Conclusion=
<pawn>//Yarrrr!</pawn>
[[Category:SourceMod Scripting]]

Useful Signatures (Source)

2007-06-05T00:56:07Z

Pimpinjuice:

=Introduction=
I have posted this page here so I can share some useful [http://wiki.alliedmods.net/Signature_Scanning sigscan] signatures. With these, and the use of [http://forums.alliedmods.net/showthread.php?t=53893 PimpinJuice's SigOffset Extension] you can call some very useful functions from within [[SourceMod]] plugins.

=The difference between SignatureScanCall and SignatureScanCall_NoIndex=
In order to truely understand the difference between the two calls, you need to know how the function you have is constructed.
Lets take two functions, CBaseEntity::Teleport and CGib::SpawnRandomGibs.
In the C++ code of the source engine, the teleport function is constructed as follows:
<pawn>void CBaseEntity::Teleport(Vector newPosition,QAngle newAngle,Vector newVelocity);</pawn>
If you look around in the source code of the source engine, you will find it called like this:
<pawn>pEntity->Teleport(location,angle,velocity);</pawn>
In the case that it is called by a pointer (pEntity->) then you use SignatureScanCall.
Now lets take the spawn random gibs construction:
<pawn>void CGib::SpawnRandomGibs(CBaseEntity *pVictim,int cGibs,GibType_e eGibType);</pawn>
If you look around, it is called like this:
<pawn>CGib::SpawnRandomGibs(pVictimEntity,6,0);</pawn>
In the case the there is NOT a pointer, you would use SignatureScanCall_NoIndex.
If you still do not understand, look below for the examples.

=Function Signatures=
This is the list of all of the functions that we have signatures for.

==CBaseEntity::Spawn==
This function is used to spawn player entities into the game. Either after creation, or re-spawn the player back to their spawn point. This function is good to call once you have changed the value of 'm_iTeamNum'. Once you have changed this value, you will need to call this function so the swapped player has the right skin and game rules associated.

'''The Signature'''
<pawn>\x83\xec\x2c\x53\x55\x56\x57\x68\x2c\x2d\x49\x22\x8b\xf1\xe8\x2d\x1c\xed\xff\x8b\x06\x8b\xce\xff\x90\x28\x04\x00\x00\x80\xbe\xad\x02\x00\x00\x01\x8d\x8e\xad\x02\x00\x00\xc6\x44\x24\x10\x01\x74\x0a\x8d\x54\x24\x10\x52\xe8\x85\xa8\xed\xff\x80\xbe\xae\x02\x00\x00\x01\x8d\x8e\xae\x02\x00\x00\xc6\x44\x24\x10\x01\x74\x0a\x8d\x44\x24\x10\x50\xe8\xb7\xa8\xed\xff\x8b\x16\x8b\xce\xff\x92\x9c\x05\x00\x00\x8b\x8e\xf8\x0b\x00\x00\x8b\xd8</pawn>

'''The Mask'''
<pawn>xxxxxxx?????xx?????xxxxxxxxxxxxxxxxxxxxxxxxxxxx??xxxxx?????xxxxxxxxxxxxxxxxxx??xxxxx?????xxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
107

'''Linux Function'''
<pawn>_ZN11CBaseEntity5SpawnEv</pawn>

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY);</pawn>

==CCSPlayer::RoundRespawn==
This function causes a dead player in CS:S to respawn at a spawn point, we all love this one.

'''The Signature'''
<pawn>\x56\x8B\xF1\x8B\x06\xFF\x90\xB8\x04\x00\x00\x8B\x86\xE8\x0D\x00\x00\x85\xC0\x74\x0E\x8B\x50\x18\x85\xD2\x74\x07\x8B\x48\x1C\x03\xCE\xFF\xD2</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxx??xxxxx??xxxxxxx</pawn>

'''Length'''
35

'''Linux Function'''
<pawn>_ZN9CCSPlayer12RoundRespawnEv</pawn>

'''Example Call'''
<pawn>SignatureScanCall(sigSpawn,client,SIGTYPE_CCSPLAYER);</pawn>

==CBaseEntity::Teleport==
This function will teleport an entity to a certain place in the world with a given vector. Useful for moving things across the world, or 'pushing' with a given force

'''The Signature'''
<pawn>\x83\xEC\x18\x53\x56\x8B\xD9\x8B\x0D\x78\xB2\x46\x22\x33\xF6\x33\xC0\x3B\xCE\x7E\x21\x8B\x15\x6C\xB2\x46\x22\xEB\x03\x8D\x49\x00\x39\x1C\x82\x74\x09\x83\xC0\x01\x3B\xC1\x7C\xF4\xEB\x08\x3B\xC6\x0F\x8D\x17\x01\x00\x00\x55\x57\x8D\x44\x24\x10\x50\x51\xB9\x6C\xB2\x46\x22\x89\x5C\x24\x18\xE8\xB4\x88\xF9\xFF\x8D\x4C\x24\x14\x51\x53\x89\x44\x24\x18\x89\x74\x24\x1C\x89\x74\x24\x20\x89\x74\x24\x24\x89\x74\x24\x28\x89\x74\x24\x2C</pawn>

'''The Mask'''
<pawn>xxxxxxx??????xxxxxx?????????????xxx?????xx????xx??????x?????xx?????xxxx?????????xxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
106

'''Linux Function'''
<pawn>_ZN11CBaseEntity8TeleportEPK6VectorPK6QAngleS</pawn>

'''Function Paramaters'''
*'''Vector newPosition'''
**The place to teleport to
*'''QAngle newAngles'''
**The new angle of the entity
*'''Vector newVelocity'''
**Directional vector for velocity

'''Example Call'''
<pawn>new Float:Pos[3];
new Float:Vel[3];
SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_VECTOR, Pos, PARAM_QANGLE, -1, PARAM_VECTOR, Vel);</pawn>

==CBaseEntity::SetModel==
This function will set the model of the entity to the model that you specify. (Yes even player models ;))

'''The Signature'''
<pawn>\x56\x8b\x74\x24\x08\x57\x8b\xf9\x8b\x0d\x8c\x69\x5f\x22\x8b\x01\x56\xff\x50\x08\x8b\x0d\x8c\x69\x5f\x22\x8b\x11\x50\xff\x52\x04\x85\xc0\x74\x20\x8b\x0d\x8c\x69\x5f\x22\x8b\x11\x50\xff\xf2\x24\x83\xf8\x01</pawn>

'''The Mask'''
<pawn>xxxxxxxx??????xxx?????????xxx???xx????????xxx??xxxx</pawn>

'''Length'''
51

'''Linux Function'''
<pawn>_ZN11CBaseEntity8SetModelEPKc</pawn>

'''Function Paramaters'''
*'''const char *szModelName'''
**The model to set to

'''Example Call'''
<pawn>PrecacheModel("models/Alyx.mdl");
SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_CONST_CHAR_PTR, "models/Alyx.mdl");</pawn>

==CBaseEntity::SetModelIndex==
This function will set the model of the entity to the model index that you specify. To see a list of models currently cached and their id's type this into server console
<pawn>sv_cheats 1;listmodels;sv_cheats 0</pawn>

'''The Signature'''
<pawn>\x53\x8b\x5c\x24\x08\x56\x57\x8b\xf9\x66\x8b\x4f\x1e\x8d\x77\x1e\x8d\x44\x24\x10\x66\x3b\x08\x74\x0c\x56\x8d\x4e\xe2\xe8\x4a\xe9\xfd\xff\x66\x89\x18\x8b\xcf</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxx????????????????????</pawn>

'''Length'''
39

'''Linux Function'''
<pawn>_ZN11CBaseEntity13SetModelIndexEi</pawn>

'''Function Paramaters'''
*'''int index '''
**The model index to set to

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_INT, 123);</pawn>

==CBasePlayer::DamageEffect==
This function shows an effect like you would get if you got damaged. Some options dont do anything, but others look kinda cool

'''The Signature'''
<pawn>\x8b\x44\x24\x08\x83\xec\x14\xa8\x01\x56\x57\xeb\xf1\x74\x36\x6a\x01\xb0\x80\x68\xcd\xcc\xcc\x3d\x88\x44\x24\x2c\x88\x44\x24\x2f\x68\x00\x00\x80\x3f\x8d\x44\x24\x30\x50\x56\xc6\x44\x24\x39\x00\xc6\x44\x24\x3a\x00\xe8\x46\x6d\x09\x00\x83\xc4\x14\x5f</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxx????xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx????xxxxx</pawn>

'''Length'''
62

'''Linux Function'''
<pawn>_ZN11CBasePlayer12DamageEffectEfi</pawn>

'''Function Paramaters'''
*'''Float flDamage'''
**[not used]
*'''int fDamageType'''
**DMG_CRUSH (1<<0)
**DMG_DROWN (1<<14)
**DMG_SLASH (1<<2)
**DMG_PLASMA (1<<24)
**DMG_SONIC (1<<9)
**MG_BULLET (1<<1)

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_FLOAT, 0, PARAM_INT, (1<<24));</pawn>

==CBasePlayer::SetFOV==
This function will change the players Field of View (FOV) with a given zoom rate

'''The Signature'''
<pawn>\x53\x57\x8b\x7c\x24\x03\x85\xff\x8b\xd9\x75\x07\x5f\x32\xc0\x5b\xc2\x0c\x00\x8b\x83\x08\x0a\x00\x00\x83\xf8\xff\x56\x8d\xb3\x08\x0a\x00\x00</pawn>

'''The Mask'''
<pawn>xxxxx????????xxxxxxxxx??????xxxxxxx</pawn>

'''Length'''
35

'''Linux Function'''
<pawn>_ZN11CBasePlayer13SetDefaultFOVEi</pawn>

'''Function Paramaters'''
*'''CBaseEntity pRequester'''
**The entity of the player to change FOV of
*'''int FOV'''
**The FOV value (0-360) anything over 180 goes foobar (default 90)
*'''Float zoomRate'''
**Time it takes for the new FOV to zoom in/out

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_CBASEENTITY, client, PARAM_INT, 95, PARAM_FLOAT, 2.0);</pawn>

==CCSPlayer::SwitchTeam (CS:S ONLY)==
This function will switch team of the player entity. It wont re-spawn the player, but it will switch the player to the new team without them dyeing.

'''The Signature'''
<pawn>\x83\xEC\x10\x56\x57\x8B\x7C\x24\x1C\x57\x8B\xF1\xE8\x7F\xE8\xF9\xFF\x83\xC4\x04\x85\xC0\x0F\x84\xEA\x00\x00\x00\x83\xFF\x03\x74\x09\x83\xFF\x02\x0F\x85\xDC\x00\x00\x00\x8B\xCE\xE8\xAF\x22\xE1\xFF\x3B\xF8\x0F\x84\xDC\x00\x00\x00\x57\x8B\xCE\xC6\x86\x14\x0E</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxx????xxxxxxxxxxxxxxxxxxxxxxxxxxxx????xxxxxxxxxxxxx??</pawn>

'''Length'''
64

'''Linux Function'''
<pawn>_ZN9CCSPlayer10SwitchTeamEi</pawn>

'''Function Paramaters'''
*'''int iTeamIndex'''
**The new team index of the player

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_INT, 2);</pawn>

==CBaseAnimating::Ignite==
This function will ignite the entity (duh)

'''The Signature'''
<pawn>\x56\x8B\xF1\x8B\x86\xBC\x00\x00\x00\xC1\xE8\x1B\xA8\x01\x0F\x85\x9A\x00\x00\x00\x8B\x16\xFF\x92\xF0\x00\x00\x00\x80\x7C\x24\x0C\x00\x74\x08\x84\xC0\x0F\x84\x83\x00\x00\x00\x3C\x01\x75\x20\x80\x7C\x24\x14\x00\x75\x19\x8B\xCE\xE8\x83\x1A\x01\x00\x85\xC0\x74\x0E\x8B\x10\x8B\xC8\xFF\x92\x08\x05\x00\x00\x84\xC0\x74\x5F\x57\x6A\x01\x56\xE8\x48\xEA\x07\x00\x8B\xF8\x83\xC4\x08\x85\xFF\x74\x3D\x8B\x44\x24\x0C\x50\x8B\xCF\xE8\x83\xE5\x07\x00\x68\x00\x00\x00\x08\x8B\xCE</pawn>

'''The Mask'''
<pawn>xxx?????????????????xxx????????????xx??????xx??xxxxx??xxx????????xxxxx?????xx??xxxxx????xxxxxxx??xxxxxxxx????xxxxxxx</pawn>

'''Length'''
116

'''Linux Function'''
<pawn>_ZN14CBaseAnimating6IgniteEfbfb</pawn>

'''Function Paramaters'''
*'''Float flFlameLifetime'''
**The time the fire should burn
*'''bool bNPCOnly'''
**I assume only NPC's get burnt
*'''float flSize'''
**Size of the flames
*'''bool bCalledByLevelDesigner'''
**Dont know what this is; I suggest setting to 0 because you are not the level designer :P

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEANIMATING, PARAM_FLOAT, 25.0, PARAM_INT, 0, PARAM_FLOAT, 100.0, PARAM_INT, 0);</pawn>

==CGib::SpawnRandomGibs==
This function will spawn head gibs from the entity. Even though the signature says 'RandomGibs' the code is only setup to spawn head gibs. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x51\x8b\x44\x24\x0c\x85\xc0\x0f\x8e\x30\x01\x00\x00\x53\x55\x56\x57\x89\x44\x24\x1c\xbb\x01\x00\x00\x00\xed\x9b\x00\x00\x00\x00\x6a\x00\x68\xd8\xeb\x58\x22\x68\x20\x73\x57\x22\x6a\x00\x6a\xff\x68\xdc\x57\x4c\x22\xe8\x46\x55\x01\x00\x83\xc4\x08</pawn>

'''The Mask'''
<pawn>xxxxxxx??????xxxxxxxxxxxx???????????????????xxxx??????????xxx</pawn>

'''Length'''
61

'''Linux Function'''
<pawn>_ZN4CGib15SpawnRandomGibsEP11CBaseEntityi9Gib</pawn>

'''Function Paramaters'''
*'''CBaseEntity pVictim'''
**The entity to spawn gibs from
*'''int cGibs'''
**The amount of gibs to spawn, I suggest anything over 1000000 ^^
*'''GibType_e eGibType'''
**GIB_HUMAN = 0 (Head gib)
**GIB_ALIEN = 1 (Head gib with some blood splatter) MUST PRECACHE "models/gibs/agibs.mdl"

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client, PARAM_INT, 10, PARAM_INT, 1);</pawn>

==UTIL_BloodDrips==
This function will spawn a small 'splash' of blood under the entity. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x57\x8b\x7c\x24\x10\x83\xff\xff\x0f\x84\xe5\x00\x00\x00\x81\xff\xf7\x00\x00\x00\x75\x0b\xa1\x18\xa6\x61\x22\x83\x78\x2c\x00\xeb\x0a\x8b\x0d\xa8\xa6\x61\x22\x83\x79\x2c\x00\x0f\x95\xc0</pawn>

'''The Mask'''
<pawn>xxxxxxxx??????xxxxxx???????xxxx????????xxxxxxx</pawn>

'''Length'''
46

'''Linux Function'''
<pawn>_Z15UTIL_BloodDripsRK6VectorS1_ii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The location to spawn the effect
*'''Vector direction'''
**Dont know what this is, i set it same as origin
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)

'''Example Call'''
<pawn>
new Float:origin[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, origin, PARAM_INT, 247);</pawn>

==UTIL_BloodStream==
Creates a moving stream of blood (like someone threw a bucket of water). Only shows pink/black (missing texture) still fun though. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x8b\x44\x24\x0c\x83\xec\x20\x50\xe8\x53\x5c\x00\x00\x83\xc4\x04\x84\xc0\x74\x61\x56\x8d\x4c\x24\x04\xe8\x42\x0b\xfa\xff\x8b\x74\x24\x28\x56\x8d\x4c\x24\x08\xc7\x44\x24\x08\x7c\x99\x4b\x22\xe8\x4c\x12\xfa\xff\x8b\x44\x24\x34\x3d\xff\x00\x00\x00</pawn>

'''The Mask'''
<pawn>xxxxxxxx?????xxxxx??xxxxx?????xxxxxxxxx?????????????xxxxxxxxx</pawn>

'''Length'''
61

'''Linux Function'''
<pawn>_Z16UTIL_BloodStreamRK6VectorS1_ii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The place the blood starts
*'''Vector direction'''
**The place the blood lands (close to)
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)
*'''int amount'''
**Dunno what this is (alpha?) set to 255

'''Example Call'''
<pawn>
new Float:origin[3];
new Float:direction[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, direction, PARAM_INT, 247, PARAM_INT, 255);</pawn>

==UTIL_BloodSpray==
Makes a blood spray (duh!)'''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x8b\x4c\x24\x0c\x83\xec\x60\x83\xf9\xff\x0f\x84\xa7\x00\x00\x00\x33\xc0\xdb\x44\x24\x70\x89\x44\x24\x34\x89\x44\x24\x44\x66\x89\x44\x24\x48\xd9\x5c\x24\x38\x89\x44\x24\x3c\x89\x44\x24\x40\x89\x44\x24\x4c</pawn>

'''The Mask'''
<pawn>xxxxxxxxxx??????xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
51

'''Linux Function'''
<pawn>_Z15UTIL_BloodSprayRK6VectorS1_iii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The place the blood starts
*'''Vector direction'''
**The place the blood lands (close to)
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)
*'''int amount'''
**Dunno what this is (alpha?) set to 255
*'''int flags'''
**0 nothing
**1 makes a baseball bat like blood spray
**2 makes a ring of blood mist
**3 makes an upward spray
**4 makes clouds of blood mist
**5 seems to be a mixture of the above
**6 seems to be a thicker cloud of dust
**(i cant be bothered to check any more. go experament)
'''Example Call'''
<pawn>
new Float:origin[3];
new Float:direction[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, direction, PARAM_INT, 247, PARAM_INT, 255, PARAM_INT, 5);</pawn>

==UTIL_Tracer (NOT CS:S)==
Uhh.. dont know i assume its for tracer stuff ^^ i guess someone will have a use for it :P '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x83\xec\x60\x8b\x44\x24\x64\x8b\x10\x89\x54\x24\x0c\x8b\x50\x04\x8b\x40\x08\x89\x44\x24\x14\x8b\x44\x24\x68\x89\x54\x24\x10\x8b\x10\x33\xc9\x38\x4c\x24\x78\x89\x14\x24\x8b\x50\x04\x8b\x40\x08\x89\x44\x24\x08\x8b\x44\x24\x97\x89</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
54

'''Linux Function'''
<pawn>_Z11UTIL_TracerRK6VectorS1_iifbPKc</pawn>

'''Function Paramaters'''
*'''Vector vecStart'''
**Starting Vector (duh)
*'''Vector vecEnd'''
**Ending Vector
*'''int EntIndex'''
**Entity index using the tracer
*'''int iAttachment'''
**Dont know (-1 for no attachement)
*'''float flVelocity'''
**Velocity the tracer moves at (m/s?)
*'''bool bWhiz'''
**I assume it emmits a sound?
*'''char ptr pCustomTracerName'''
**A nice name for your tracer
'''Example Call'''
<pawn>
new Float:start[3];
new Float:end[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, start, PARAM_VECTOR, end, PARAM_INT, client, PARAM_INT, -1, PARAM_FLOAT, 10.0, PARAM_INT, 1, PARAM_CONST_CHAR_PTR, "OLLY");</pawn>

==SetMinMaxSize==
Sets the size of the collision box around a Physics entity '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x53\x8b\x5c\x24\x0c\x55\x8b\x6c\x24\x14\x56\x57\x8b\xf5\x2b\xdd\xbf\x03\x00\x00\x00\xd9\x04\x33\xd8\x1e\xdf\xe0\xf6\xc4\x41\x75\x23\x8b\x4c\x24\x14\x85\xc9</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx??xxxxxx</pawn>

'''Length'''
39

'''Linux Function'''
<pawn> [cant find someone help me out?] </pawn>

'''Function Paramaters'''
*'''CBaseEntity pEnt'''
**The entity ptr of the entity you are working with
*'''Vector mins'''
**The minimum size the box will 'squash' to when you run into it
*'''Vector max'''
**The maximum size

'''Example Call'''
<pawn>
new Float:min[3];
new Float:max[3];
SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client, PARAM_VECTOR, min, PARAM_VECTOR, max);</pawn>

==CreateEntityByName==
Creates a new entity from the classname specified (Does NOT spawn the entity) '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x56\x8b\x74\x24\x0c\x83\xfe\xff\x57\x8b\x7c\x24\x0c\x74\x25\x8b\x0d\x68\x69\x5f\x22\x8b\x01\x56\xff\x50\x54\x85\xc0\xa3\x9c\xfa\x5c\x22\x75\x10\x56\x57\x68\x08\x6d\x4e\x22\xff\x15\xfc\xb1\x48\x22\x83\xc4\x0c</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxx??xxxxxxxxx???xx???????xx???????????xxx</pawn>

'''Length'''
52

'''Linux Function'''
<pawn>_Z18CreateEntityByNamePKci</pawn>

'''Function Paramaters'''
*'''char ptr classname'''
**The classname of the entity to make
*'''int iForceEdictIndex'''
**Manually set the edict ID (dont set for auto) (MUST BE > 64)

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CONST_CHAR_PTR, "hostage_entity");</pawn>

'''Result'''
[[Image:De_dust0012.jpg]]

==DispatchSpawn==
Used to spawn created entities, or to respawn players '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x53\x55\x56\x8b\x74\x24\x10\x85\xf6\x57\x0f\x84\x3a\x01\x00\x00\x8b\x1d\xa4\x69\x5f\x22\x8b\x03\x8b\xcb\xff\x50\x60\x8b\x16\x8b\xce\xff\x52\x08\x8b\x0d\xa4\x69\x5f\x22\x8b\x28</pawn>

'''The Mask'''
<pawn>xxxxxxxxxx????????????xxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
44

'''Linux Function'''
<pawn>_Z13DispatchSpawnP11CBaseEntity</pawn>

'''Function Paramaters'''
*'''CBaseEntity pEntity'''
**The entity to spawn

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client);</pawn>

=Conclusion=
<pawn>//Yarrrr!</pawn>
[[Category:SourceMod Scripting]]

Useful Signatures (Source)

2007-05-29T13:54:17Z

Pimpinjuice:

=Introduction=
I have posted this page here so I can share some useful [http://wiki.alliedmods.net/Signature_Scanning sigscan] signatures. With these, and the use of [http://forums.alliedmods.net/showthread.php?t=53893 PimpinJuice's SigOffset Extension] you can call some very useful functions from within [[SourceMod]] plugins.

=The difference between SignatureScanCall and SignatureScanCall_NoIndex=
In order to truely understand the difference between the two calls, you need to know how the function you have is constructed.
Lets take two functions, CBaseEntity::Teleport and CGib::SpawnRandomGibs.
In the C++ code of the source engine, the teleport function is constructed as follows:
<pawn>void CBaseEntity::Teleport(Vector newPosition,QAngle newAngle,Vector newVelocity);</pawn>
If you look around in the source code of the source engine, you will find it called like this:
<pawn>pEntity->Teleport(location,angle,velocity);</pawn>
In the case that it is called by a pointer (pEntity->) then you use SignatureScanCall.
Now lets take the spawn random gibs construction:
<pawn>void CGib::SpawnRandomGibs(CBaseEntity *pVictim,int cGibs,GibType_e eGibType);</pawn>
If you look around, it is called like this:
<pawn>CGib::SpawnRandomGibs(pVictimEntity,6,0);</pawn>
In the case the there is NOT a pointer, you would use SignatureScanCall_NoIndex.
If you still do not understand, look below for the examples.

=Function Signatures=
This is the list of all of the functions that we have signatures for.

==CBaseEntity::Spawn==
This function is used to spawn player entities into the game. Either after creation, or re-spawn the player back to their spawn point. This function is good to call once you have changed the value of 'm_iTeamNum'. Once you have changed this value, you will need to call this function so the swapped player has the right skin and game rules associated.

'''The Signature'''
<pawn>\x83\xec\x2c\x53\x55\x56\x57\x68\x2c\x2d\x49\x22\x8b\xf1\xe8\x2d\x1c\xed\xff\x8b\x06\x8b\xce\xff\x90\x28\x04\x00\x00\x80\xbe\xad\x02\x00\x00\x01\x8d\x8e\xad\x02\x00\x00\xc6\x44\x24\x10\x01\x74\x0a\x8d\x54\x24\x10\x52\xe8\x85\xa8\xed\xff\x80\xbe\xae\x02\x00\x00\x01\x8d\x8e\xae\x02\x00\x00\xc6\x44\x24\x10\x01\x74\x0a\x8d\x44\x24\x10\x50\xe8\xb7\xa8\xed\xff\x8b\x16\x8b\xce\xff\x92\x9c\x05\x00\x00\x8b\x8e\xf8\x0b\x00\x00\x8b\xd8</pawn>

'''The Mask'''
<pawn>xxxxxxx?????xx?????xxxxxxxxxxxxxxxxxxxxxxxxxxxx??xxxxx?????xxxxxxxxxxxxxxxxxx??xxxxx?????xxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
107

'''Linux Function'''
<pawn>_ZN11CBaseEntity5SpawnEv</pawn>

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY);</pawn>

==CBaseEntity::Teleport==
This function will teleport an entity to a certain place in the world with a given vector. Useful for moving things across the world, or 'pushing' with a given force

'''The Signature'''
<pawn>\x83\xEC\x18\x53\x56\x8B\xD9\x8B\x0D\x78\xB2\x46\x22\x33\xF6\x33\xC0\x3B\xCE\x7E\x21\x8B\x15\x6C\xB2\x46\x22\xEB\x03\x8D\x49\x00\x39\x1C\x82\x74\x09\x83\xC0\x01\x3B\xC1\x7C\xF4\xEB\x08\x3B\xC6\x0F\x8D\x17\x01\x00\x00\x55\x57\x8D\x44\x24\x10\x50\x51\xB9\x6C\xB2\x46\x22\x89\x5C\x24\x18\xE8\xB4\x88\xF9\xFF\x8D\x4C\x24\x14\x51\x53\x89\x44\x24\x18\x89\x74\x24\x1C\x89\x74\x24\x20\x89\x74\x24\x24\x89\x74\x24\x28\x89\x74\x24\x2C</pawn>

'''The Mask'''
<pawn>xxxxxxx??????xxxxxx?????????????xxx?????xx????xx??????x?????xx?????xxxx?????????xxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
106

'''Linux Function'''
<pawn>_ZN11CBaseEntity8TeleportEPK6VectorPK6QAngleS</pawn>

'''Function Paramaters'''
*'''Vector newPosition'''
**The place to teleport to
*'''QAngle newAngles'''
**The new angle of the entity
*'''Vector newVelocity'''
**Directional vector for velocity

'''Example Call'''
<pawn>new Float:Pos[3];
new Float:Vel[3];
SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_VECTOR, Pos, PARAM_QANGLE, -1, PARAM_VECTOR, Vel);</pawn>

==CBaseEntity::SetModel==
This function will set the model of the entity to the model that you specify. (Yes even player models ;))

'''The Signature'''
<pawn>\x56\x8b\x74\x24\x08\x57\x8b\xf9\x8b\x0d\x8c\x69\x5f\x22\x8b\x01\x56\xff\x50\x08\x8b\x0d\x8c\x69\x5f\x22\x8b\x11\x50\xff\x52\x04\x85\xc0\x74\x20\x8b\x0d\x8c\x69\x5f\x22\x8b\x11\x50\xff\xf2\x24\x83\xf8\x01</pawn>

'''The Mask'''
<pawn>xxxxxxxx??????xxx?????????xxx???xx????????xxx??xxxx</pawn>

'''Length'''
51

'''Linux Function'''
<pawn>_ZN11CBaseEntity8SetModelEPKc</pawn>

'''Function Paramaters'''
*'''const char *szModelName'''
**The model to set to

'''Example Call'''
<pawn>PrecacheModel("models/Alyx.mdl");
SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_CONST_CHAR_PTR, "models/Alyx.mdl");</pawn>

==CBaseEntity::SetModelIndex==
This function will set the model of the entity to the model index that you specify. To see a list of models currently cached and their id's type this into server console
<pawn>sv_cheats 1;listmodels;sv_cheats 0</pawn>

'''The Signature'''
<pawn>\x53\x8b\x5c\x24\x08\x56\x57\x8b\xf9\x66\x8b\x4f\x1e\x8d\x77\x1e\x8d\x44\x24\x10\x66\x3b\x08\x74\x0c\x56\x8d\x4e\xe2\xe8\x4a\xe9\xfd\xff\x66\x89\x18\x8b\xcf</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxx????????????????????</pawn>

'''Length'''
39

'''Linux Function'''
<pawn>_ZN11CBaseEntity13SetModelIndexEi</pawn>

'''Function Paramaters'''
*'''int index '''
**The model index to set to

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_INT, 123);</pawn>

==CBasePlayer::DamageEffect==
This function shows an effect like you would get if you got damaged. Some options dont do anything, but others look kinda cool

'''The Signature'''
<pawn>\x8b\x44\x24\x08\x83\xec\x14\xa8\x01\x56\x57\xeb\xf1\x74\x36\x6a\x01\xb0\x80\x68\xcd\xcc\xcc\x3d\x88\x44\x24\x2c\x88\x44\x24\x2f\x68\x00\x00\x80\x3f\x8d\x44\x24\x30\x50\x56\xc6\x44\x24\x39\x00\xc6\x44\x24\x3a\x00\xe8\x46\x6d\x09\x00\x83\xc4\x14\x5f</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxx????xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx????xxxxx</pawn>

'''Length'''
62

'''Linux Function'''
<pawn>_ZN11CBasePlayer12DamageEffectEfi</pawn>

'''Function Paramaters'''
*'''Float flDamage'''
**[not used]
*'''int fDamageType'''
**DMG_CRUSH (1<<0)
**DMG_DROWN (1<<14)
**DMG_SLASH (1<<2)
**DMG_PLASMA (1<<24)
**DMG_SONIC (1<<9)
**MG_BULLET (1<<1)

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_FLOAT, 0, PARAM_INT, (1<<24));</pawn>

==CBasePlayer::SetFOV==
This function will change the players Field of View (FOV) with a given zoom rate

'''The Signature'''
<pawn>\x53\x57\x8b\x7c\x24\x03\x85\xff\x8b\xd9\x75\x07\x5f\x32\xc0\x5b\xc2\x0c\x00\x8b\x83\x08\x0a\x00\x00\x83\xf8\xff\x56\x8d\xb3\x08\x0a\x00\x00</pawn>

'''The Mask'''
<pawn>xxxxx????????xxxxxxxxx??????xxxxxxx</pawn>

'''Length'''
35

'''Linux Function'''
<pawn>_ZN11CBasePlayer13SetDefaultFOVEi</pawn>

'''Function Paramaters'''
*'''CBaseEntity pRequester'''
**The entity of the player to change FOV of
*'''int FOV'''
**The FOV value (0-360) anything over 180 goes foobar (default 90)
*'''Float zoomRate'''
**Time it takes for the new FOV to zoom in/out

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_CBASEENTITY, client, PARAM_INT, 95, PARAM_FLOAT, 2.0);</pawn>

==CCSPlayer::SwitchTeam (CS:S ONLY)==
This function will switch team of the player entity. It wont re-spawn the player, but it will switch the player to the new team without them dyeing.

'''The Signature'''
<pawn>\x83\xEC\x10\x56\x57\x8B\x7C\x24\x1C\x57\x8B\xF1\xE8\x7F\xE8\xF9\xFF\x83\xC4\x04\x85\xC0\x0F\x84\xEA\x00\x00\x00\x83\xFF\x03\x74\x09\x83\xFF\x02\x0F\x85\xDC\x00\x00\x00\x8B\xCE\xE8\xAF\x22\xE1\xFF\x3B\xF8\x0F\x84\xDC\x00\x00\x00\x57\x8B\xCE\xC6\x86\x14\x0E</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxx????xxxxxxxxxxxxxxxxxxxxxxxxxxxx????xxxxxxxxxxxxx??</pawn>

'''Length'''
64

'''Linux Function'''
<pawn>_ZN9CCSPlayer10SwitchTeamEi</pawn>

'''Function Paramaters'''
*'''int iTeamIndex'''
**The new team index of the player

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEENTITY, PARAM_INT, 2);</pawn>

==CBaseAnimating::Ignite==
This function will ignite the entity (duh)

'''The Signature'''
<pawn>\x56\x8B\xF1\x8B\x86\xBC\x00\x00\x00\xC1\xE8\x1B\xA8\x01\x0F\x85\x9A\x00\x00\x00\x8B\x16\xFF\x92\xF0\x00\x00\x00\x80\x7C\x24\x0C\x00\x74\x08\x84\xC0\x0F\x84\x83\x00\x00\x00\x3C\x01\x75\x20\x80\x7C\x24\x14\x00\x75\x19\x8B\xCE\xE8\x83\x1A\x01\x00\x85\xC0\x74\x0E\x8B\x10\x8B\xC8\xFF\x92\x08\x05\x00\x00\x84\xC0\x74\x5F\x57\x6A\x01\x56\xE8\x48\xEA\x07\x00\x8B\xF8\x83\xC4\x08\x85\xFF\x74\x3D\x8B\x44\x24\x0C\x50\x8B\xCF\xE8\x83\xE5\x07\x00\x68\x00\x00\x00\x08\x8B\xCE</pawn>

'''The Mask'''
<pawn>xxx?????????????????xxx????????????xx??????xx??xxxxx??xxx????????xxxxx?????xx??xxxxx????xxxxxxx??xxxxxxxx????xxxxxxx</pawn>

'''Length'''
116

'''Linux Function'''
<pawn>_ZN14CBaseAnimating6IgniteEfbfb</pawn>

'''Function Paramaters'''
*'''Float flFlameLifetime'''
**The time the fire should burn
*'''bool bNPCOnly'''
**I assume only NPC's get burnt
*'''float flSize'''
**Size of the flames
*'''bool bCalledByLevelDesigner'''
**Dont know what this is; I suggest setting to 0 because you are not the level designer :P

'''Example Call'''
<pawn>SignatureScanCall(sig_id, client, SIGTYPE_CBASEANIMATING, PARAM_FLOAT, 25.0, PARAM_INT, 0, PARAM_FLOAT, 100.0, PARAM_INT, 0);</pawn>

==CGib::SpawnRandomGibs==
This function will spawn head gibs from the entity. Even though the signature says 'RandomGibs' the code is only setup to spawn head gibs. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x51\x8b\x44\x24\x0c\x85\xc0\x0f\x8e\x30\x01\x00\x00\x53\x55\x56\x57\x89\x44\x24\x1c\xbb\x01\x00\x00\x00\xed\x9b\x00\x00\x00\x00\x6a\x00\x68\xd8\xeb\x58\x22\x68\x20\x73\x57\x22\x6a\x00\x6a\xff\x68\xdc\x57\x4c\x22\xe8\x46\x55\x01\x00\x83\xc4\x08</pawn>

'''The Mask'''
<pawn>xxxxxxx??????xxxxxxxxxxxx???????????????????xxxx??????????xxx</pawn>

'''Length'''
61

'''Linux Function'''
<pawn>_ZN4CGib15SpawnRandomGibsEP11CBaseEntityi9Gib</pawn>

'''Function Paramaters'''
*'''CBaseEntity pVictim'''
**The entity to spawn gibs from
*'''int cGibs'''
**The amount of gibs to spawn, I suggest anything over 1000000 ^^
*'''GibType_e eGibType'''
**GIB_HUMAN = 0 (Head gib)
**GIB_ALIEN = 1 (Head gib with some blood splatter) MUST PRECACHE "models/gibs/agibs.mdl"

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client, PARAM_INT, 10, PARAM_INT, 1);</pawn>

==UTIL_BloodDrips==
This function will spawn a small 'splash' of blood under the entity. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x57\x8b\x7c\x24\x10\x83\xff\xff\x0f\x84\xe5\x00\x00\x00\x81\xff\xf7\x00\x00\x00\x75\x0b\xa1\x18\xa6\x61\x22\x83\x78\x2c\x00\xeb\x0a\x8b\x0d\xa8\xa6\x61\x22\x83\x79\x2c\x00\x0f\x95\xc0</pawn>

'''The Mask'''
<pawn>xxxxxxxx??????xxxxxx???????xxxx????????xxxxxxx</pawn>

'''Length'''
46

'''Linux Function'''
<pawn>_Z15UTIL_BloodDripsRK6VectorS1_ii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The location to spawn the effect
*'''Vector direction'''
**Dont know what this is, i set it same as origin
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)

'''Example Call'''
<pawn>
new Float:origin[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, origin, PARAM_INT, 247);</pawn>

==UTIL_BloodStream==
Creates a moving stream of blood (like someone threw a bucket of water). Only shows pink/black (missing texture) still fun though. '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x8b\x44\x24\x0c\x83\xec\x20\x50\xe8\x53\x5c\x00\x00\x83\xc4\x04\x84\xc0\x74\x61\x56\x8d\x4c\x24\x04\xe8\x42\x0b\xfa\xff\x8b\x74\x24\x28\x56\x8d\x4c\x24\x08\xc7\x44\x24\x08\x7c\x99\x4b\x22\xe8\x4c\x12\xfa\xff\x8b\x44\x24\x34\x3d\xff\x00\x00\x00</pawn>

'''The Mask'''
<pawn>xxxxxxxx?????xxxxx??xxxxx?????xxxxxxxxx?????????????xxxxxxxxx</pawn>

'''Length'''
61

'''Linux Function'''
<pawn>_Z16UTIL_BloodStreamRK6VectorS1_ii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The place the blood starts
*'''Vector direction'''
**The place the blood lands (close to)
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)
*'''int amount'''
**Dunno what this is (alpha?) set to 255

'''Example Call'''
<pawn>
new Float:origin[3];
new Float:direction[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, direction, PARAM_INT, 247, PARAM_INT, 255);</pawn>

==UTIL_BloodSpray==
Makes a blood spray (duh!)'''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x8b\x4c\x24\x0c\x83\xec\x60\x83\xf9\xff\x0f\x84\xa7\x00\x00\x00\x33\xc0\xdb\x44\x24\x70\x89\x44\x24\x34\x89\x44\x24\x44\x66\x89\x44\x24\x48\xd9\x5c\x24\x38\x89\x44\x24\x3c\x89\x44\x24\x40\x89\x44\x24\x4c</pawn>

'''The Mask'''
<pawn>xxxxxxxxxx??????xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
51

'''Linux Function'''
<pawn>_Z15UTIL_BloodSprayRK6VectorS1_iii</pawn>

'''Function Paramaters'''
*'''Vector origin'''
**The place the blood starts
*'''Vector direction'''
**The place the blood lands (close to)
*'''int color'''
**BLOOD_COLOR_RED = 247 (Wont work on German games :S)
**BLOOD_COLOR_YELLOW = 195
**BLOOD_COLOR_MECH = 20 (Makes smoke and sparks too)
*'''int amount'''
**Dunno what this is (alpha?) set to 255
*'''int flags'''
**0 nothing
**1 makes a baseball bat like blood spray
**2 makes a ring of blood mist
**3 makes an upward spray
**4 makes clouds of blood mist
**5 seems to be a mixture of the above
**6 seems to be a thicker cloud of dust
**(i cant be bothered to check any more. go experament)
'''Example Call'''
<pawn>
new Float:origin[3];
new Float:direction[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, origin, PARAM_VECTOR, direction, PARAM_INT, 247, PARAM_INT, 255, PARAM_INT, 5);</pawn>

==UTIL_Tracer (NOT CS:S)==
Uhh.. dont know i assume its for tracer stuff ^^ i guess someone will have a use for it :P '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x83\xec\x60\x8b\x44\x24\x64\x8b\x10\x89\x54\x24\x0c\x8b\x50\x04\x8b\x40\x08\x89\x44\x24\x14\x8b\x44\x24\x68\x89\x54\x24\x10\x8b\x10\x33\xc9\x38\x4c\x24\x78\x89\x14\x24\x8b\x50\x04\x8b\x40\x08\x89\x44\x24\x08\x8b\x44\x24\x97\x89</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
54

'''Linux Function'''
<pawn>_Z11UTIL_TracerRK6VectorS1_iifbPKc</pawn>

'''Function Paramaters'''
*'''Vector vecStart'''
**Starting Vector (duh)
*'''Vector vecEnd'''
**Ending Vector
*'''int EntIndex'''
**Entity index using the tracer
*'''int iAttachment'''
**Dont know (-1 for no attachement)
*'''float flVelocity'''
**Velocity the tracer moves at (m/s?)
*'''bool bWhiz'''
**I assume it emmits a sound?
*'''char ptr pCustomTracerName'''
**A nice name for your tracer
'''Example Call'''
<pawn>
new Float:start[3];
new Float:end[3];
SignatureScanCall_NoIndex(sig_id, PARAM_VECTOR, start, PARAM_VECTOR, end, PARAM_INT, client, PARAM_INT, -1, PARAM_FLOAT, 10.0, PARAM_INT, 1, PARAM_CONST_CHAR_PTR, "OLLY");</pawn>

==SetMinMaxSize==
Sets the size of the collision box around a Physics entity '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x53\x8b\x5c\x24\x0c\x55\x8b\x6c\x24\x14\x56\x57\x8b\xf5\x2b\xdd\xbf\x03\x00\x00\x00\xd9\x04\x33\xd8\x1e\xdf\xe0\xf6\xc4\x41\x75\x23\x8b\x4c\x24\x14\x85\xc9</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx??xxxxxx</pawn>

'''Length'''
39

'''Linux Function'''
<pawn> [cant find someone help me out?] </pawn>

'''Function Paramaters'''
*'''CBaseEntity pEnt'''
**The entity ptr of the entity you are working with
*'''Vector mins'''
**The minimum size the box will 'squash' to when you run into it
*'''Vector max'''
**The maximum size

'''Example Call'''
<pawn>
new Float:min[3];
new Float:max[3];
SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client, PARAM_VECTOR, min, PARAM_VECTOR, max);</pawn>

==CreateEntityByName==
Creates a new entity from the classname specified (Does NOT spawn the entity) '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x56\x8b\x74\x24\x0c\x83\xfe\xff\x57\x8b\x7c\x24\x0c\x74\x25\x8b\x0d\x68\x69\x5f\x22\x8b\x01\x56\xff\x50\x54\x85\xc0\xa3\x9c\xfa\x5c\x22\x75\x10\x56\x57\x68\x08\x6d\x4e\x22\xff\x15\xfc\xb1\x48\x22\x83\xc4\x0c</pawn>

'''The Mask'''
<pawn>xxxxxxxxxxxxx??xxxxxxxxx???xx???????xx???????????xxx</pawn>

'''Length'''
52

'''Linux Function'''
<pawn>_Z18CreateEntityByNamePKci</pawn>

'''Function Paramaters'''
*'''char ptr classname'''
**The classname of the entity to make
*'''int iForceEdictIndex'''
**Manually set the edict ID (dont set for auto) (MUST BE > 64)

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CONST_CHAR_PTR, "hostage_entity");</pawn>

'''Result'''
[[Image:De_dust0012.jpg]]

==DispatchSpawn==
Used to spawn created entities, or to respawn players '''NOTE: This function requires no pointer, check the Example Call to see how to get round this'''

'''The Signature'''
<pawn>\x53\x55\x56\x8b\x74\x24\x10\x85\xf6\x57\x0f\x84\x3a\x01\x00\x00\x8b\x1d\xa4\x69\x5f\x22\x8b\x03\x8b\xcb\xff\x50\x60\x8b\x16\x8b\xce\xff\x52\x08\x8b\x0d\xa4\x69\x5f\x22\x8b\x28</pawn>

'''The Mask'''
<pawn>xxxxxxxxxx????????????xxxxxxxxxxxxxxxxxxxxxx</pawn>

'''Length'''
44

'''Linux Function'''
<pawn>_Z13DispatchSpawnP11CBaseEntity</pawn>

'''Function Paramaters'''
*'''CBaseEntity pEntity'''
**The entity to spawn

'''Example Call'''
<pawn>SignatureScanCall_NoIndex(sig_id, PARAM_CBASEENTITY, client);</pawn>

=Conclusion=
<pawn>//Yarrrr!</pawn>
[[Category:SourceMod Scripting]]