Squirrel/Server/Functions/Vehicles/SirenLight

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|Vehicle.SirenLight}} This ''Vehicle'' class member returns whether the vehicle's siren light is enabled or enables/disables it. Note that this member is only val…')
 
 
Line 1: Line 1:
 
{{Squirrel/Title|Vehicle.SirenLight}}
 
{{Squirrel/Title|Vehicle.SirenLight}}
 +
{{ScriptingChangesIn0.1.0.11}}
 
This ''Vehicle'' class member returns whether the vehicle's siren light is enabled or enables/disables it. Note that this member is only valid for vehicles with a siren.
 
This ''Vehicle'' class member returns whether the vehicle's siren light is enabled or enables/disables it. Note that this member is only valid for vehicles with a siren.
  

Latest revision as of 23:13, 12 September 2011

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

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

[edit] Syntax

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

  1. bool Vehicle.SirenLight
  1. Vehicle.SirenLight = bool enabled

[edit] Arguments

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

[edit] Example 1. Returning 

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

[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 == "slighton" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) pPlayer.Vehicle.SirenLight = true;
  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/SirenLight&oldid=3109"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox