OnPlayerDeath: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
mNo edit summary
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
This is called when a player dies. e.g.: drowned or self-kill.
#REDIRECT [[Scripting/Squirrel/Events/OnPlayerDeath]]
 
== 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
* '''''Death from an explosion''''' - 41
* '''''Death from drowning''''' - 43
 
== 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;
}
}
}
</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}}

Latest revision as of 19:24, 18 April 2016