Squirrel/Server/Functions/Vehicles/Health

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Example 2. Setting)
(→‎Example 2. Setting)
 
Line 46: Line 46:
 
=== Notes ===
 
=== Notes ===
  
−
The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
+
The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in this example. More info about this in the corresponding page.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Vehicles}}
 
{{Squirrel/Server/Functions/Vehicles}}

Latest revision as of 17:08, 29 September 2010

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

This Vehicle class member returns or sets the vehicle engine health. Note that max. vehicle health is 1000.0.

[edit] Syntax

You can either return or set a new value using this member: 

  1. float Vehicle.Health
  1. Vehicle.Health = float health

[edit] Arguments

  • health - The new engine health of the vehicle

[edit] Example 1. Returning 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "vehhp" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle health is " + pPlayer.Vehicle.Health, pPlayer );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The function MessagePlayer and event onPlayerCommand were used in this example. More info about them in the corresponding pages.

[edit] Example 2. Setting 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "vehhp2" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) pPlayer.Vehicle.Health = 1000.00;
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

The event onPlayerCommand was used in this example. More info about this in the corresponding page.

[edit] Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Vehicles/Health&oldid=1772"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox