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
No edit summary
No edit summary
Line 7: Line 7:
== Arguments ==
== Arguments ==


* '''player''' - player's pointer
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that died
* '''reason''' - how the player dies
* ''int'' '''reason''' - [[Scripting/Squirrel/Events/OnPlayerDeath#Death_Reasons|Death reason]]
 
=== Death Reasons ===
 
* '''''Death from falling''''' - 44
* '''''Death from an explosion''''' - 41
* '''''Death from drowning''''' - 43


== Example ==
== Example ==
Line 15: Line 21:
function onPlayerDeath( player, reason )
function onPlayerDeath( player, reason )
{
{
    Message( "** " + player.Name + " died." );  
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>
</source>
Line 21: Line 44:
=== Notes ===
=== 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.
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 ==
== Related Functions ==


{{Scripting/Squirrel/Events/Player_Events}}
{{Scripting/Squirrel/Events/Player_Events}}

Revision as of 21:13, 1 July 2015

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

Syntax

function onPlayerDeath( player, reason )

Arguments

Death Reasons

  • Death from falling - 44
  • Death from an explosion - 41
  • Death from drowning - 43

Example

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;
		}
	}
}

Notes

The functions Message and Player.Name were used in this example. More info about them in corresponding pages.

Related Functions