Vehicle.Health

From Liberty Unleashed Wiki
Jump to: navigation, search
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.

Syntax

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

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

Arguments

  • health - The new engine health of the vehicle

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. return 1;
  9. }
  10.  

Notes

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

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. return 1;
  9. }
  10.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox