Vehicle.Siren

From Liberty Unleashed Wiki
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. if ( szCommand == "siren" )
  5. {
  6. if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle's siren is currently - " + pPlayer.Vehicle.Siren, 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 == "sirenon" )
  5. {
  6. if ( pPlayer.Vehicle ) pPlayer.Vehicle.Siren = true;
  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