Vehicle.Siren

From Liberty Unleashed Wiki
Revision as of 22:04, 12 September 2011 by AdTec 224 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Vehicle class member returns whether the vehicle's siren is enabled or enables/disables it. Note that this member is only valid for vehicles with a siren.

Syntax

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

  1. bool Vehicle.Siren
  1. Vehicle.Siren = bool enabled

Arguments

  • enabled - A boolean representing whether siren should be enabled (true) or disabled (false)

Example 1. Returning 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	
  5. 	if ( szCommand == "siren" )
  6. 	{
  7. 		if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle's siren is currently - " + pPlayer.Vehicle.Siren, pPlayer );
  8. 	}
  9. 	
  10. 	return 1;
  11. }
  12.  

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 == "sirenon" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) pPlayer.Vehicle.Siren = true;
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

Notes

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

Related Functions

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

Variants
Actions
Navigation
scripting
Toolbox