Vice City Multiplayer - User contributions [en]

OnPlayerKill

2019-06-22T20:43:00Z

Thijn: Undo revision 20321 by Aventador (talk)

This event is called every time a player kills another (and they're not in the same team).

== Syntax ==

<pre>function onPlayerKill( killer, player, reason, bodypart )</pre>

== Arguments ==

* '''player''' - He is who is attacking
* '''killer''' - He is who is being killed
* '''reason''' - [[Weapons|Weapon ID]]
* '''bodypart''' - [[Scripting/Squirrel/Constants#Body_Part|Bodypart ID]]

== Example ==

<source lang="squirrel">
function onPlayerKill( killer, player, reason, bodypart )
{
Message( "** " + killer.Name + " killed " + player.Name + " (" + GetWeaponName( reason ) + ") (" + bodypart + ")" );
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]], [[Scripting/Squirrel/Functions/Player.Name|Player.Name]], [[Scripting/Squirrel/Functions/GetWeaponName|GetWeaponName]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

Server-side Scripting Resources

2019-06-22T20:42:47Z

Thijn:

{{Main Page giant banner}}
<br />
{{VCMPLangs
| title=Server-side Scripting Resources
| hu=Server-side_Scripting_Resources/hu
}}
<br />
{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
|-
| style="width:auto; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
<div id="mf-index">
{| style="padding:0; width:100%;" |
! class="mp-content-header mp-title-gradient" | Server-side Scripting Resources
|-
| style="padding:10px;" |
</div>
|-
|}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
<div id="mf-index">
|-
| style="padding:10px;" |
==Introduction==

Squirrel is a high level imperative/OO programming language, designed to be a powerful scripting tool that fits in the size, memory bandwidth, and real-time requirements of applications like games.

Squirrel is inspired by languages like Python, Javascript and especially Lua.

Squirrel's syntax is similar to C/C++/Java etc... but the language has a very dynamic nature like Python/Lua.

== Scripts ==

The following is a list of example Squirrel scripts

* [https://bitbucket.org/stormeus/vl8-pb400 0.4 Public Beta (#2 and #3) Script]
* [http://forum.vc-mp.org/?topic=332.0 ADM Script]
* [http://forum.vc-mp.org/?topic=418.0 Doomplay match]

== Useful Resources ==

The following is a list of handy releases/resources to help you with big stuff

* [http://forum.vc-mp.org/?topic=1303.0 VC:MP Ingame Map Editor]

== Reference ==

* [[Scripting/Squirrel/Functions|Server Functions]]
* [[Scripting/Squirrel/Events|Server Events]]
* [[Scripting/Squirrel/Constants|Constants]]

== Tutorials / Documentation ==

This is a list of available tutorials and documents on Squirrel scripting in general.
These list all available squirrel commands aside from things added by the VC:MP Squirrel module, and are not listed on this wiki.

'''''VC:MP Squirrel Scripting'''''
* [http://forum.vc-mp.org/?topic=717.0 -WIP- Scripting Video Tutorials (by S.L.C)]

'''''General Squirrel Scripting'''''
* [http://squirrel-lang.org/squirreldoc/ Squirrel Reference and Standard Libraries Manual (Online)]
* [http://squirrel-lang.org/squirreldoc/squirrel3.pdf Squirrel Reference Manual (PDF)]
* [http://squirrel-lang.org/squirreldoc/sqstdlib3.pdf Squirrel Standard Libraries Manual (PDF)]
* [https://electricimp.com/docs/squirrel An excellent Squirrel Programming Guide for beginners]

== Official plugins ==
* [https://bitbucket.org/stormeus/0.4-announce/downloads Announce]
* [https://bitbucket.org/stormeus/0.4-confloader/downloads ConfLoader]
* [https://bitbucket.org/stormeus/0.4-hashing-algorithms/downloads Hashing Algorithms]
* [https://bitbucket.org/stormeus/0.4-iniparser/downloads INIParser]
* [https://bitbucket.org/stormeus/0.4-mysql/downloads MySQL]
* [https://bitbucket.org/stormeus/0.4-sockets/downloads Sockets]
* [https://bitbucket.org/stormeus/0.4-sqlite/downloads SQLite]
* [https://bitbucket.org/stormeus/0.4-squirrel/downloads Squirrel]

Plugin packages are also available for compact downloading and updating.
* [http://files.thijn.ovh/download/3ad83726d7a7eee9264f500831e3b898/vcmp_04rel004_win32-plug_170220.zip Windows (x86) Package]
* [http://files.thijn.ovh/download/b7f8ccd07e4d2118e535227f2185706f/vcmp_04rel004_win64-plug_170220.zip Windows (x64) Package]
* [http://files.thijn.ovh/download/504c5023ed34f9d655039d2003ca4fa2/vcmp_04rel004_lin32-plug_170220.zip Linux (x86) Package]
* [http://files.thijn.ovh/download/e28b0ee6d2fe39afd019245258507290/vcmp_04rel004_lin64-plug_170220.zip Linux (x64) Package]
</div>
|}

Talk:Main Page

2019-06-22T20:41:16Z

Thijn: Undo revision 20329 by Aventador (talk)

<pre>Main page look and feel may be replaced soon!</pre>

Weapons

2019-06-22T20:41:10Z

Thijn: Undo revision 20333 by Aventador (talk)

{{Main Page giant banner}}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
|-
| style="width:auto; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
<div id="mf-index">
{| style="padding:0; width:100%;" |
! class="mp-content-header mp-title-gradient" | Standard Weapons
|-
| style="padding:10px;" |
This is the full list of default weapons, but let me tell you something:
*You can add your own weapons in your server !! For more details, check this => [[Custom_Files#Weapons|Custom Weapons]]
|}

{| style="width:100%; background:none; border:none; margin:0.5em 0; padding:none;" cellspacing="0" cellpadding="0"
| style="width:auto; background:#FEFBF6; border:1px solid #79542B;" valign="top" |
<div id="mf-index">
|-
{| class="wikitable sortable"
!Weapon
!Weapon ID
!Model ID
!Description
|-
|[[File:Weapon_0.png]]
|0
|293
|Fists
|-
|[[File:Weapon_1.png]]
|1
|259
|Brass Knuckles
|-
|[[File:Weapon_2.png]]
|2
|260
|Screwdriver
|-
|[[File:Weapon_3.png]]
|3
|261
|Golfclub
|-
|[[File:Weapon_4.png]]
|4
|262
|Nitestick
|-
|[[File:Weapon_5.png]]
|5
|263
|Knife
|-
|[[File:Weapon_6.png]]
|6
|264
|Baseball bat
|-
|[[File:Weapon_7.png]]
|7
|265
|Hammer
|-
|[[File:Weapon_8.png]]
|8
|266
|Meat Cleaver
|-
|[[File:Weapon_9.png]]
|9
|267
|Machete
|-
|[[File:Weapon_10.png]]
|10
|268
|Katana
|-
|[[File:Weapon_11.png]]
|11
|269
|Chainsaw
|-
|[[File:Weapon_12.png]]
|12
|270
|Grenades
|-
|[[File:Weapon_12.png]]
|13
|291
|Remote Grenades
|-
|[[File:Weapon_14.png]]
|14
|271
|Teargas
|-
|[[File:Weapon_15.png]]
|15
|272
|Molotov Cocktails
|-
|[[File:Weapon_30.png]]
|16
|273
|Missile
|-
|[[File:Weapon_17.png]]
|17
|274
|Colt .45
|-
|[[File:Weapon_18.png]]
|18
|275
|Python
|-
|[[File:Weapon_19.png]]
|19
|277
|Shotgun
|-
|[[File:Weapon_20.png]]
|20
|278
|Spaz Shotgun
|-
|[[File:Weapon_21.png]]
|21
|279
|Stubby Shotgun
|-
|[[File:Weapon_22.png]]
|22
|281
|Tec 9
|-
|[[File:Weapon_23.png]]
|23
|282
|Uzi
|-
|[[File:Weapon_24.png]]
|24
|283
|Ingram
|-
|[[File:Weapon_25.png]]
|25
|284
|MP5
|-
|[[File:Weapon_26.png]]
|26
|280
|M4
|-
|[[File:Weapon_27.png]]
|27
|276
|Ruger
|-
|[[File:Weapon_28.png]]
|28
|285
|Sniper Rifle
|-
|[[File:Weapon_29.png]]
|29
|286
|Laser Sniper
|-
|[[File:Weapon_30.png]]
|30
|287
|Rocket Launcher
|-
|[[File:Weapon_31.png]]
|31
|288
|Flame Thrower
|-
|[[File:Weapon_32.png]]
|32
|289
|M60
|-
|[[File:Weapon_33.png]]
|33
|290
|Minigun
|-
|
|34
|
|Bomb
|-
|
|35
|
|Helicannon
|-
|[[File:Weapon_36.png]]
|36
|292
|Camera
|-
|
|39
|
|Vehicle
|-
|
|40
|
|Heli-blades
|-
|
|41
|
|Explosion
|-
|
|42
|
|Drive-By
|-
|
|43
|
|Drown
|-
|
|44
|
|Fall
|-
|
|51
|
|Explosion
|-
|
|60
|
|Heli-blades
|-
|
|70
|
|Suicide
|}

How to join a server

2019-06-22T20:41:02Z

Thijn: Undo revision 20334 by Aventador (talk)

== How to join a server ==
joining a server is very easy , if it was your you must make sure that
1-Set the Username from Tools > Settings
2-Choosed the directory of GTA VC
after that choose Internet TAB
from any server right click > connect or use Enter
if you see a green sqaure next to a server then it is open if it red then it is locked maybe for maintenance or for private gaming.

== VC:MP Console ==
to use the console of VC:MP in a server use T letter to chat or enter a command
'''Commands That work in all server''' /kill for seduce and /q for rapid quitting

Scripting/Squirrel/Functions/SetWeaponSync

2019-06-22T20:40:54Z

Thijn: Undo revision 20338 by Aventador (talk)

{{Scripting/Noop}}

== Related Functions ==

{{Scripting/Squirrel/Functions/Server_Settings}}
[[Category:Scripting/Squirrel/Functions/Server_Settings _Functions]]

Scripting/Squirrel/Functions

2019-06-22T20:40:26Z

Thijn: Undo revision 20339 by Aventador (talk)

== Administrative Functions ==
{{Scripting/Squirrel/Functions/Administrative Functions}}

== Checkpoint Functions ==
{{Scripting/Squirrel/Functions/Checkpoint Functions}}

== Data Structures ==
{{Scripting/Squirrel/Functions/Data Structures}}

== Game Functions ==
{{Scripting/Squirrel/Functions/Game Functions}}

== Hashing Functions (In the "Hashing" plugin) ==
{{Scripting/Squirrel/Functions/Hashing Functions}}

== INI Functions (In the "INIParser" plugin) ==
{{Scripting/Squirrel/Functions/INI Functions}}

== Messages ==
{{Scripting/Squirrel/Functions/Messages}}

== MySQL Functions (In the "MySQL" plugin) ==
{{Scripting/Squirrel/Functions/MySQL Functions}}

== Object Functions ==
{{Scripting/Squirrel/Functions/Object Functions}}

== Pickup Functions ==
{{Scripting/Squirrel/Functions/Pickup Functions}}

== Player Functions ==
{{Scripting/Squirrel/Functions/Player Functions}}

== SQLite Functions (In the "SQLite" plugin) ==
{{Scripting/Squirrel/Functions/SQLite Functions}}

== Server Settings ==
{{Scripting/Squirrel/Functions/Server Settings}}

== Socket Functions (In the "Socket" plugin) ==
{{Scripting/Squirrel/Functions/Socket Functions}}

== Spawn and Wasted Screen Functions ==
{{Scripting/Squirrel/Functions/Spawn and Wasted Screen Functions}}

== Timer Functions ==
{{Scripting/Squirrel/Functions/Timer Functions}}

== Vehicle Functions ==
{{Scripting/Squirrel/Functions/Vehicle Functions}}

== Weapon Functions ==
{{Scripting/Squirrel/Functions/Weapon Functions}}

== Deprecated Functions ==
''These functions are for compatibility, but may be removed in future versions.''
{{Scripting/Squirrel/Functions/Deprecated}}

User:MaricruzWalsh7

2019-06-22T20:39:56Z

Thijn: Blanked the page

User talk:G

2019-06-22T20:39:27Z

Thijn: Blanked the page

Main Page

2019-06-22T20:38:26Z

Thijn: Removed redirect to User talk:G

OnPlayerExitVehicle

2017-01-30T22:22:13Z

Thijn:

This event is called when a player exits a Vehicle.

== Syntax ==
<pre>onPlayerExitVehicle( player, vehicle )</pre>

== Arguments ==
* ''CPlayer'' '''player''' - The player instance, or, the one who is exiting the vehicle.
* ''CVehicle'' '''player''' - The vehicle instance, or, the vehicle which is being exited by the player.

== Example ==
<source lang="squirrel">
function onPlayerExitVehicle( player, vehicle )
{
Message( player.Name + " has exited " + GetVehicleNameFromModel( vehicle.Model ) + "." );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Vehicle_Events}}
[[Category:Scripting/Squirrel/Events/Vehicle_Events]]

OnVehicleHealthChange

2017-01-30T22:22:03Z

Thijn:

==Description==
This event is called when a vehicles Health is changed.
==Syntax==
<pre>OnVehicleHealthChange( vehicle, oldHP, newHP )</pre>
==Example==
<pre>
function OnVehicleHealthChange( vehicle, oldHP, newHP )
{
Message("Vehicle: "+vehicle+"'s health has been changed to "+newHP+" from "+oldHP)
}</pre>

== Related Functions ==

{{Scripting/Squirrel/Events/Vehicle_Events}}
[[Category:Scripting/Squirrel/Events/Vehicle_Events]]

OnVehicleExplode

2017-01-30T22:21:55Z

Thijn:

This event is called when a vehicle gets exploded.

== Syntax ==
<pre>onVehicleExplode( vehicle )</pre>

== Arguments ==
* ''CVehicle'' '''vehicle''' - The vehicle instance, or, the vehicle which got exploded.

== Example ==
<pre>function onVehicleExplode( vehicle ) {
Message( vehicle.ID + ", " + GetVehicleNameFromModel( vehicle.Model ) + " got exploded.");
}</pre>

== Related Functions ==

{{Scripting/Squirrel/Events/Vehicle_Events}}
[[Category:Scripting/Squirrel/Events/Vehicle_Events]]

OnPlayerEnterVehicle

2017-01-30T22:21:48Z

Thijn:

This event is called when a player enters a Vehicle.

== Syntax ==
<pre>onPlayerEnterVehicle( player, vehicle, door )</pre>

== Arguments ==
* ''CPlayer'' '''player''' - The player instance, or the one who is trying to enter.
* ''CVehicle'' '''vehicle''' - The vehicle instance, or the vehicle which is being entered by the player.
* ''int'' '''door''' - The door in which the player is entering, i.e, 0 for driver, 1 for passenger.

== Example ==
<source lang="squirrel">
function onPlayerEnterVehicle( player, vehicle, door )
{
Message( player.Name + " has Entered "+GetVehicleNameFromModel( vehicle.Model ) + "." );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Vehicle_Events}}
[[Category:Scripting/Squirrel/Events/Vehicle_Events]]

OnVehicleRespawn

2017-01-30T22:21:42Z

Thijn:

This event is called when a vehicle is respawned.

== Syntax ==
<pre>onVehicleRespawn( vehicle )</pre>

== Arguments ==
* ''CVehicle'' '''vehicle''' - The vehicle instance, or the vehicle which is being respawned.

== Example ==
<pre>function onVehicleRespawn( vehicle ) {
Message( vehicle.ID + " respawned!");
}</pre>

== Related Functions ==

{{Scripting/Squirrel/Events/Vehicle_Events}}
[[Category:Scripting/Squirrel/Events/Vehicle_Events]]

OnPlayerEnteringVehicle

2017-01-30T22:21:35Z

Thijn:

This event is called when a player tries to enter a vehicle

== Syntax ==
<pre>onPlayerEnteringVehicle( player, vehicle, door )</pre>

== Arguments ==
* ''CPlayer'' '''player''' - The player instance, or the one who is trying to enter.
* ''CVehicle'' '''vehicle''' - The vehicle instance, or the vehicle which is being entered by the player.
* ''int'' '''door''' - The door in which the player is entering, i.e, 0 for driver, 1 for passenger.

== Example ==
<source lang="squirrel">
function onPlayerEnteringVehicle( player, vehicle, door )
{
Message( player.Name + " is entering " + GetVehicleNameFromModel( vehicle.Model ) + "." );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Vehicle_Events}}
[[Category:Scripting/Squirrel/Events/Vehicle_Events]]

OnSphereExited

2017-01-30T22:21:21Z

Thijn:

This event is called when a players exits a sphere.

== Syntax ==
<pre>onSphereExited( player, sphere )</pre>

== Arguments ==
* ''CPlayer'' '''player''' - The player instance, or the one who exited the sphere.
* ''CSphere'' '''sphere''' - The sphere instance, or the sphere which got exited by the player

== Example ==
<pre>function onSphereExited( player, sphere ){
PrivMessage(player,"You exited sphere number " + sphere.ID );
}</pre>

== Related Functions ==

{{Scripting/Squirrel/Events/Sphere_Events}}
[[Category:Scripting/Squirrel/Events/Sphere_Events]]

OnScriptLoad

2017-01-30T22:20:27Z

Thijn:

== Description ==

Executed whenever the script is loaded (including reload)

== Example ==

<source lang="squirrel">
function onScriptLoad()
{
print( "== Loaded Squirrel VC:MP Script ==" );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

OnSphereEntered

2017-01-30T22:20:21Z

Thijn:

This is called when a player enters any sphere.

== Syntax ==
function OnSphereEntered( player, sphere )

== Example ==
<source lang="squirrel">
function OnSphereEntered( player, sphere )
{
MessagePlayer("You're entered a sphere! ID " + sphere.ID , player );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Sphere_Events}}
[[Category:Scripting/Squirrel/Events/Sphere_Events]]

OnScriptUnload

2017-01-30T22:20:13Z

Thijn:

== Description ==

Executed when the script is removed from memory

== Example ==

<source lang="squirrel">
function onScriptUnload()
{
print( "== Unloaded Squirrel VC:MP Script ==" );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

OnServerStop

2017-01-30T22:20:06Z

Thijn:

== Syntax ==

<pre>onServerStop()</pre>

----

== Arguments ==

* ''None''

----

== Example ==

The Following Example Will Print "The Server Is Closing" When The Server Is Closed!
<source lang=squirrel>
function onServerStop()
{
print( "The Server Is Closing" );
}
</source>
----

== Notes ==

Function print() was used in this example.The print() function outputs a formatted string on the console.

== Related Functions ==

{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

OnServerStart

2017-01-30T22:19:52Z

Thijn:

== Syntax ==
<pre>onServerStart()</pre>
----
== Arguments ==

* ''None''
----

== Example ==

The following example will print "Hello World!" when the server is started.
<source lang=squirrel>
function onServerStart()
{
print( "Hello World!" );
}
</source>

== Notes ==

Function print() was used in this example.The print() function outputs a formatted string on the console.

== Related Functions ==

{{Scripting/Squirrel/Events/Server_Events}}
[[Category:Scripting/Squirrel/Events/Server_Events]]

OnPlayerJoin

2017-01-30T22:18:36Z

Thijn:

This is called when a player joins the server. This is fired ''after'' data has been sent to the client.

== Syntax ==

<pre>function onPlayerJoin( player )</pre>

== Arguments ==

* '''player''' - The pointer of the new player

== Example ==

<source lang="squirrel">
function onPlayerJoin( player )
{
MessagePlayer( "Welcome " + player.Name + " to the server.", player );
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerRequestClass

2017-01-30T22:17:50Z

Thijn:

This event is called every time a player wants to spawn.

== Syntax ==

<pre>function onPlayerRequestClass( player, classID, team, skin )</pre>

== Arguments ==

* '''player''' - Player who is spawning.
* '''classID''' - Player's class.
* '''team''' - Player's team.
* '''skin''' - Player's skin.

== Example ==

<source lang="squirrel">
function onPlayerRequestClass( player, classID, team, skin )
{
Announce("Please choose a skin",player,1);
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerCrouchChange

2017-01-30T22:17:38Z

Thijn:

__NOTOC__
This Function is trigged when a player is crouching.

== Syntax ==

<pre>function onPlayerCrouchChange( player, isCrouchingNow )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the action.
* ''Bool'' '''isCrouchingNow''' - checks if the player is crouching.

== Example ==
In this example, Whenever the player Will crouch, he will receive a message that "you are crouching now".
<source lang=squirrel>
function onPlayerCrouchChange( player, isCrouchingNow )
{
if ( isCrouchingNow ) //checks if the player is crouching.
{
PrivMessage( player, " you are crouching right now." );
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] was used in this example.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerGameKeysChange

2017-01-30T22:17:26Z

Thijn:

__NOTOC__
This function detects the players "Game Key". for example: To move FORWARD we usually use "W" or "UP_ARROW" key. But since its a game key & its ID is "32768".
It will detect that the player is moving forward. No matter what key/button player has set to move forward. Even if the player set the key "X".

== Syntax ==

<pre>function onPlayerGameKeysChange( player, oldKey, newKey )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the keys.
* '''old''' - Player's old key which was pressed before pressing the new one.
* '''new''' - Players new key. recently pressed key.

== Example ==

In This Example, When a player will move "FORWARD", player will receive a message "you are moving forward"...no matter what button player has set to move forward...
If "BACKWARDS", player will receive a message "you are moving backward"...no matter what button player has set to move backwards...
If "RIGHT", player will receive a message "you are moving to right side" ... no matter what button player has set to move right side...
and If "LEFT", player will receive a message "you are moving to left side "... no matter what button player has set to move left side...

<source lang=squirrel>
function onPlayerGameKeysChange( player, oldKey, newKey )
{
if ( newKey == 32768 ) // this is the id of FORWARD game key.
{
PrivMessage( player, "you are moving forward" );
}
else if ( newKey == 16384 ) // this is the id of BACKWARDS game key.
{
PrivMessage( player, "you are moving backward" );
}
else if ( newKey == 4096 ) // this is the id of RIGHT game key.
{
PrivMessage( player, "you are moving to right side" );
}
else if ( newKey == 8192 ) // this is the id of LEFT game key.
{
PrivMessage( player, "you are moving to left side" );
}
}
</source>
To Get The Keys ID use this.
<source lang=squirrel>

function onPlayerGameKeysChange( player, oldKey, newKey )
{
if ( newKey )
{
PrivMessage( player, "recently pressed key's ID: "+newKey );
}
}
</source>

here are some constants by Gudio.
<source lang=squirrel>
KEY_ONFOOT_FORWARD
KEY_ONFOOT_BACKWARD
KEY_ONFOOT_LEFT
KEY_ONFOOT_RIGHT
KEY_ONFOOT_JUMP
KEY_ONFOOT_CROUCH
KEY_ONFOOT_PUNCH
KEY_ONFOOT_AIM
KEY_ONFOOT_FIRE
KEY_ONFOOT_NEXTWEP
KEY_ONFOOT_PREVWEP

KEY_INCAR_FORWARD
KEY_INCAR_BACKWARD
KEY_INCAR_LEFT
KEY_INCAR_RIGHT
KEY_INCAR_LOOKLEFT
KEY_INCAR_LOOKRIGHT
KEY_INCAR_LEANUP
KEY_INCAR_LEANDOWN
</source>
=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] was used in this example

To know more about this function. visit [[http://forum.vc-mp.org/?topic=212.msg1122#msg1122|''here'']]

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerOnFireChange

2017-01-30T22:17:17Z

Thijn:

==Description==
This event is called when a player is burning or stopped burning.
==Syntax==
onPlayerOnFireChange( player, isOnFireNow )
==Example==
<pre>
function onPlayerOnFireChange( player, isOnFireNow )
{
MessagePlayer("Your burn status: "+isOnFireNow,player)
}</pre>

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnKeyUp

2017-01-30T22:17:10Z

Thijn:

__NOTOC__
This function allows the server to inform the player, that He dropped the key and and the key works like a command.

== Syntax ==

<pre>function onKeyUp( player, key )</pre>

== Parameters ==

* '''player''' - The player who presses the key.
* '''key''' - The key player presses.

== Example ==

In this function i have chosen key "ENTER". When a player will dropped the key/button 'enter' it will inform the server that the player dropped the key. And the server will perform the work like a Command.

<source lang=squirrel>
function onScriptLoad()
{
enter <- BindKey( true, 0x0D, 0, 0 ); // The Key Code of enter is 0x0D . we will use bindkey function to set the key. And it is required.
}

function onKeyUp( player, key )
{
if ( key == enter )
{
PrivMessage( player, "you Successfully dropped the Key Enter." );
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/BindKey|''BindKey'']] were used in this example.

you can Find the key codes [[https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx|''here'']]

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerActionChange

2017-01-30T22:17:03Z

Thijn:

__NOTOC__
This function is triggered when a player changes his action or we can say move!. ( not animation ).

== Syntax ==

<pre>function onPlayerActionChange( player, oldAction, newAction )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the action.
* '''oldAction''' - Players old Action.
* '''newAction''' - Players new Action.

== Example ==

In this example i have chosen action "Fire/Shoot", when a player will Fire/shoot, his weapon will be automatically removed for temporary reason. ( the player won't be disarmed ), until he is firing/shooting, he won't be able to use weapons. unless he changes his action. the player will also receive a message "you can't shoot in a RPG server.".

<source lang=squirrel>
function onPlayerActionChange( player, oldAction, newAction )
{
if ( newAction == 16 ) // 16 is the id of firing/shooting action.
{
player.SetWeapon( 0, 0 ); //sets weapon to 0. which is nothing.
PrivMessage( player, "you can't shoot in a RPG server. );
}
}
</source>

you must be wondering how to get actions id?. use this to get ids :)
<source lang=squirrel>
function onPlayerActionChange( player, oldAction, newAction )
{
if ( newAction ) // it will check if the player goes in new action.
{
PrivMessage( player, "your Current Actions ID: "+newAction ); // it will print the id of the action player is in.
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/Player.SetWeapon|''SetWeapon'']] were used in this example.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerCrashDump

2017-01-30T22:16:56Z

Thijn:

This event is called every time a player crashes.

== Syntax ==

Function invoke
<pre>function onPlayerCrashDump( player, CrashReport )</pre>

== Arguments ==

* '''player''' - One who crashed
* '''CrashReport''' - Reason

== Example ==

<source lang="squirrel">
function onPlayerCrashDump( player, CrashReport ) Message( "** " + player.Name + " left server. [Crash]!" );
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]], [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerNameChange

2017-01-30T22:16:50Z

Thijn:

Called when a player changes his name.

== Syntax ==

<pre>function OnPlayerNameChange( player, oldName, newName )</pre>

== Arguments ==

*[[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that changed his name
*''string'' '''oldName''' - Old name (before the player changed his name)
*''string'' '''newName''' - new name (after the player changed his name)

== Example ==

<source lang=squirrel>
function onPlayerNameChange( player, oldName, newName )
{
Message(oldName + " is now known as " + newName);
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerAwayChange

2017-01-30T22:16:43Z

Thijn:

if ( NewStatus == true )
{
Message("" +player.Name+" will be right back.");
}
else if ( NewStatus == false )
{
Message(""+player.Name+" Is Now Back!");
}

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnKeyDown

2017-01-30T22:16:37Z

Thijn:

__NOTOC__
This function allows the server to inform the player, that he pressed the key and and the key works like a command.

== Syntax ==

<pre>function onKeyDown( player, key )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who presses the key.
* '''key''' - The key player presses.

== Example ==

In this function i have chosen key "ENTER". When a player will press the key/button 'enter' it will inform the server that the player pressed the key. And the server will perform the work like a Command.

<source lang=squirrel>
function onScriptLoad()
{
enter <- BindKey( true, 0x0D, 0, 0 ); // The Key Code of enter is 0x0D . we will use bindkey function to set the key. And it is required.
}

function onKeyDown( player, key )
{
if ( key == enter )
{
PrivMessage( player, "you Successfully pressed the Key Enter." );
}
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/BindKey|''BindKey'']] were used in this example.

you can Find the key codes [[https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx|''here'']]

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerArmourChange

2017-01-30T22:16:31Z

Thijn:

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerEndTyping

2017-01-30T22:16:23Z

Thijn:

This event is called every time a player stops typing in chat box.

== Syntax ==

<pre>function onPlayerEndTyping( player )</pre>

== Arguments ==

* '''player''' - He is who stopped typing

== Example ==

<source lang="squirrel">
function onPlayerEndTyping( player )
{
Announce( "~r~Stopped Typing", player, 1 );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerWeaponChange

2017-01-30T22:16:16Z

Thijn:

__NOTOC__
When a player changes his weapon to newone or oldone.

== Syntax ==

<pre>function onPlayerWeaponChange( player, oldwep, newwep )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the weapon.
* '''oldwep''' - Players old weapon
* '''newwep''' - Players new weapon

== Example ==

If a player will try to change his weapon to "33" ( minigun ), this example will automatically set his weapons ammo to 0. and in result, he won't be able to use that weapon.

<source lang=squirrel>
function onPlayerWeaponChange( player, oldwep, newwep )
{
if ( newwep == 33 )
{
PrivMessage( player, "it is a blocked weapon" );
player.SetWeapon( 33,0 ); //sets weapons ammo to 0.
}
return 1; //returns true for other weapons.
}
</source>

=== Notes ===

Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/Player.SetWeapon|''SetWeapon'']] were used in this example.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerHealthChange

2017-01-30T22:16:10Z

Thijn:

This is called when player's health amount changes.

== Syntax ==

<pre>function onPlayerHealthChange( player, lastHP, newHP )</pre>

== Parameters ==

* '''player''' - The pointer of the player
* '''lastHP''' - The amount of health player had before the change
* '''newHP''' - The current health amount

== Example ==

This will tell the player if they got hurt.

<source lang="squirrel">
function onPlayerHealthChange( player, lastHP, newHP )
{
if ( lastHP > newHP ) MessagePlayer( "You just lost " + ( lastHP - newHP ) + " health.", player );
}
</source>

=== Notes ===

The function [[Scripting/Squirrel/Functions/MessagePlayer|MessagePlayer]] was used in in this example. More info about it in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerCommand

2017-01-30T22:16:03Z

Thijn:

__NOTOC__
This is called when a player uses a command.

== Syntax ==

<pre>function onPlayerCommand( player, cmd, parameters )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that used the command.
* ''string'' '''cmd''' - The command that player used.
* ''string'' '''text''' - List of command parameters as string.

== Example ==

This example command heal the player if they type '''/heal'''.

<source lang=squirrel>
function onPlayerCommand( player, cmd, text )
{
if ( cmd == "heal" )
{
if ( player.Health == 100 ) PrivMessage( player, "You have the health to maximum.");
else
{
PrivMessage( player, "You healed successfully.");
player.Health = 100;
}
}
</source>

=== Notes ===

Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerMove

2017-01-30T22:15:57Z

Thijn:

__NOTOC__
This is called when a player moves on foot or as a passenger.

== Syntax ==

<pre>function onPlayerMove( player, oldX, oldY, oldZ, newX, newY, newZ )</pre>

== Parameters ==

* '''player''' - The pointer of the player
* '''oldX''' - Old X coordinate
* '''oldY''' - Old Y coordinate
* '''oldZ''' - Old Z coordinate
* '''newX''' - New X coordinate
* '''newY''' - New Y coordinate
* '''newZ''' - New Z coordinate

== Example ==

This example will move the player back to point (0, 0, 0) if they move too far away from it.

<source lang="squirrel">
function onPlayerMove( player, x1, y1, z1, x2, y2, z2 )
{
if ( sqrt( x2*x2 + y2*y2 + z2*z2 ) > 50 ) player.Pos = Vector( 0.0, 0.0, 0.0 );
}
</source>

=== Notes ===

The function [[Scripting/Squirrel/Functions/Player.Pos|Player.Pos]] was used in in this example. More info about it in the corresponding page.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnLoginAttempt

2017-01-30T22:15:50Z

Thijn:

This is called when a player attempts to join the server.

== Syntax ==

<pre>function onLoginAttempt( playerName, password, ipAddress )</pre>

== Arguments ==

* '''playerName''' - The name of the new player.
* '''password''' - The password that the player used to login.
* '''ipAddress''' - The IP address of the new player.

== Example ==

<source lang="squirrel">
function onLoginAttempt( playerName, password, ipAddress )
{
if ( playerName == "blocked_name" )
return false; // Reject
return true; // Allow
}
</source>

=== Notes ===

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerPM

2017-01-30T22:15:42Z

Thijn:

this function allows you to send a private Message ( PM ) to a player.

== Syntax ==

<pre>function onPlayerPM( player, playerTo, text )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that sends the message.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''playerTo''' - The player to send the message.
* ''string'' '''text''' - this is the message to send.

== Example ==

<source lang=squirrel>
function onPlayerPM( player, playerTo, text )
{
if ( text )
{
PrivMessage( playerTo, "PrivateMessage From: [ "+player+" ] >> "+text+".");
PrivMessage( player, "PM: ["+text+"] was sent to "+ playerTo );
}
else PrivMessage( player, "SYNTAX: /msg [player's ID] [text]" );
return 0;
}
</source>

=== Notes ===

The function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and call [[onPlayerPM]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerBeginTyping

2017-01-30T22:15:36Z

Thijn:

This event is called every time a player starts typing in chat box.

== Syntax ==

<pre>function onPlayerBeginTyping( player )</pre>

== Arguments ==

* '''player''' - He is who started typing

== Example ==

<source lang="squirrel">
function onPlayerBeginTyping( player )
{
Announce( "~r~Started Typing", player, 1 );
}
</source>

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerChat

2017-01-30T22:15:27Z

Thijn:

__NOTOC__
This is called when a player uses a command.

== Syntax ==

<pre>function onPlayerChat( player, message )</pre>

== Parameters ==

* [[Scripting/Squirrel/Functions#Player_Functions|Player]] '''player''' - The player.
* ''string'' '''message''' - This is the message that player sent.

== Example ==

This example command outputs the player messages.

<source lang=squirrel>
function onPlayerChat( player, message )
{
print("Player:"+player.Name+" Says:"+message);
}
</source>

=== Notes ===

The function print and call [[onPlayerChat]] were used in this example. More info about them in the corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerTeamKill

2017-01-30T22:15:21Z

Thijn:

This event is called when a player kills another player from the same team.

== Syntax ==

<pre>function onPlayerTeamKill( killer, player, reason, bodypart )</pre>

== Arguments ==

* '''killer''' - He is who is attacking
* '''player''' - He is who is being killed
* '''reason''' - Weapon ID
* '''bodypart''' - Bodypart ID

== Example ==

<source lang="squirrel">
function onPlayerKill( killer, player, reason, bodypart )
{
Message( "** " + killer.Name + " team-killed " + player.Name " (" + GetWeaponName( reason ) + ") (" + bodypart + ")" );
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]], [[Scripting/Squirrel/Functions/Player.Name|Player.Name]], [[Scripting/Squirrel/Functions/GetWeaponName|GetWeaponName]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

Scripting/Squirrel/Events/OnPlayerDeath

2017-01-30T22:15:13Z

Thijn:

This is called when a player dies. e.g.: drowned or self-kill.

== Syntax ==

<pre>function onPlayerDeath( player, reason )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that died
* ''int'' '''reason''' - [[OnPlayerDeath#Death_Reasons|Death reason]]

=== Death Reasons ===

* '''''Death from falling''''' - 44 '''(WEP_FALL)'''
* '''''Death from an explosion''''' - 41
* '''''Death from drowning''''' - 43 '''(WEP_DROWNED)'''
* '''''Death from dying in a car''''' - 39 '''(WEP_VEHICLE)'''
* '''''Suicide''''' - 70 '''(WEP_SUICIDE)'''

== Example ==

<source lang="squirrel">
function onPlayerDeath( player, reason )
{
switch (reason)
{
case 44:
{
Message(player.Name + " fell down and died.");
break;
}
case 41:
{
Message(player.Name + " exploded to bits!");
break;
}
case 43:
{
Message(player.Name + " drowned to death.");
break;
}
case 39:
{
Message(player.Name + " died in a car accident.");
break;
}
case 70:
{
Message(player.Name + " suicided.");
break;
}
}
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerKill

2017-01-30T22:15:07Z

Thijn:

OnPlayerSpawn

2017-01-30T22:15:01Z

Thijn:

This is called when a player spawns.

== Syntax ==

<pre>function onPlayerSpawn( player )</pre>

== Parameters ==

* '''player''' - The pointer of the player

== Example ==

This will message the chat when a player spawns.

<source lang="squirrel">
function onPlayerSpawn( player )
{
Message( "*** " + player.Name + " spawned as skin " + GetSkinName( player.Skin ) );
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]], [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] and [[Scripting/Squirrel/Functions/Player.Skin|Player.Skin]] were used in in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerRequestSpawn

2017-01-30T22:14:53Z

Thijn:

when a players requests to spawn.
== Syntax ==

<pre>function onPlayerRequestSpawn( player )</pre>

== Arguments ==

* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The Pointer of the player.

== Example ==

<source lang=squirrel>
function onPlayerRequestSpawn( player )
{
PrivMessage( player, "you will be spawned in 3 seconds." );
NewTimer( "spawnplayer", 3000, 1, player.ID );
return 0;
}

// Timers Call Back
function spawnplayer( ID )
{
local player = FindPlayer( ID );
if ( player )
{
player.Spawn();
PrivMessage( player, "you have been spawned" );
}
else return 0;
}
</source>

== Notes ==

The function [[http://wiki.vc-mp.org/wiki/Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and call [[onPlayerRequestSpawn]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPlayerPart

2017-01-30T22:14:40Z

Thijn:

This is called when a player disconnects from the server.

== Syntax ==

<pre>function onPlayerPart( player, reason )</pre>

== Arguments ==

* '''player''' - The pointer of the player
* '''reason''' - Reason ID for the part.

== Example ==

In this example the server will send a message when a player leaves the server.
<source lang="squirrel">
function onPlayerPart( player, reason )
{
switch (reason)
{
case 1:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+" [#ffffff]quit.");
EchoMessage( ICOL_GREEN + " [PART] "+player.Name+" Quito El Juego.");
break;
}
case 1:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+" [#ffffff]Disconnected");
EchoMessage( ICOL_GREEN + "[PART] "+player.Name+" Desconecto El juego");
break;
}
case 0:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+ " [#ffffff]timeout.");
EchoMessage( ICOL_GREEN + " [PART] "+player.Name+ " Internet Fuera.");
break;
}
case 2:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+ " [#ffffff]Kicked for banned.");
EchoMessage( ICOL_GREEN + " [PART] "+player.Name+ " Kickeado Por Prohibicion.");
break;
}
case 2:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+" [#FFFFFF]Kicked.");
EchoMessage( ICOL_GREEN + " [PART] "+player.Name+" Kickeado.");
break;
}
case 2:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+" [#FFFFFF]banned.");
EchoMessage( ICOL_GREEN + " [PART] "+player.Name+" Prohibido.");
break;
}
case 3:
{
Message("[#FF77AF][PART] [#ac8000] "+player.Name+" [#FFFFFF]Error Crash.");
EchoMessage( ICOL_GREEN + " [PART] "+player.Name+" Error del VC.");
break;
}
}
}
</source>

=== Notes ===

The functions [[Scripting/Squirrel/Functions/Message|Message]] and [[Scripting/Squirrel/Functions/Player.Name|Player.Name]] were used in this example. More info about them in corresponding pages.

== Related Functions ==

{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

OnPickupRespawn

2017-01-30T22:12:34Z

Thijn:

This event is called when a pickup is respawned.

== Syntax ==
<pre>onPickupRespawn( pickup )</pre>

== Arguments ==
* ''CPickup'' '''pickup''' - The pickup instance, for the functions list, see [[Scripting/Squirrel/Functions#Pickup_Functions|Pickup functions]]

== Example ==
<pre>function onPickupRespawn( pickup ){
print("Pickup (" + pickup.ID + ") respawned!");
}</pre>

== Related Functions ==

{{Scripting/Squirrel/Events/Pickup_Events}}
[[Category:Scripting/Squirrel/Events/Pickup_Events]]