Squirrel/Client/Events/Player/onClientShot

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|onClientShot}} This event is called when the local player gets shot. == Syntax == <code>function onClientShot( player, weapon, bodypart )</code> === Arguments…')
 
(→‎Example)
Line 19: Line 19:
 
== Example ==
 
== Example ==
  
−
Some explanation here
+
This example makes you invincible if you're called 'Bob' (does not apply to damage taken from other players).
−
{{Squirrel/NeedsExample}}
+
−
 
+
 
<code lang="squirrel">
 
<code lang="squirrel">
−
-- todo
+
function onClientHurt(entity)
 +
{
 +
// Get the local player
 +
local player = FindLocalPlayer();
 +
if(player)
 +
{
 +
// Check if they're called "Bob"
 +
local name = player.Name;
 +
if(name == "Bob")
 +
{
 +
// Cancel the damage
 +
return 0;
 +
}
 +
}
 +
}
 
</code>
 
</code>
  

Revision as of 21:03, 11 November 2013

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This event is called when the local player gets shot.

Syntax 

  1. function onClientShot( player, weapon, bodypart )

Arguments

  • player - The pointer to the player that hurt the local player
  • weapon - The weapon used
  • bodypart - The bodypart that was hit

Returns

  • 1 - Let the player be hurt normally
  • 0 - Stops the player being hurt

Example

This example makes you invincible if you're called 'Bob' (does not apply to damage taken from other players). 

  1.  
  2. function onClientHurt(entity)
  3. {
  4. 	// Get the local player
  5. 	local player = FindLocalPlayer();
  6. 	if(player)
  7. 	{
  8. 		// Check if they're called "Bob"
  9. 		local name = player.Name;
  10. 		if(name == "Bob")
  11. 		{
  12. 			// Cancel the damage
  13. 			return 0;
  14. 		}
  15. 	}
  16. }
  17.  

Notes

-- List of used functions and other notes here.

Related Events

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Client/Events/Player/onClientShot&oldid=41271"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox